search

Sage-Bionetworks / synapseDocs

Synapse documentation pages
https://docs.synapse.org
7 stars 36 forks source link

Add PR + Issues templates #764

Closed thomasyu888 closed 4 years ago

thomasyu888 commented 4 years ago

Not sure what else to add to this, but please feel free to add to this. fixes #627

Aryllen commented 4 years ago

This is a personal preference so I would like @kelshmo to weigh in, as well. I tend to prefer templates that are not meant to be deleted before submission, but rather be more of a questionnaire/checklist style that should be filled out and kept in the PR. I think this helps in a couple ways.

  1. The person reviewing the PR can see if the person ran it locally, looked at the contributing guide, etc.
  2. It makes it harder to ignore and makes the person a bit more accountable.

My suggestion would be to remove the request to delete the template and leave the checklist (maybe add verification that they've looked at the guide). The question in the checklist about there being an issue could be changed to something like "did you reference the GH issue being addressed by number?"

Again, these are my preferences and I would defer to @kelshmo's ideas since she is doing the most work on this project.

thomasyu888 commented 4 years ago

I think I agree with that. An example of a nice issues from templates can be found in pandas GitHub: https://github.com/pandas-dev/pandas/issues

Aryllen commented 4 years ago

An example of a nice issues from templates can be found in pandas GitHub: https://github.com/pandas-dev/pandas/issues

Oh, that is nice!

thomasyu888 commented 4 years ago

Thanks @Aryllen , I made some edits.

Aryllen commented 4 years ago

I noticed that you removed the bit about running locally. You could potentially keep that, but make a note that it isn't required (we don't want to discourage people from contributing). Personally, I think it helps to know if someone actually tried it locally (I expect less build errors).