Add a PR template #1980
Add a PR template #1980
Conversation
alexpetros
added
the
ready for review
|
|
||
| ## Testing | ||
| *Please explain how you tested this change manually, and, if applicable, what new tests you added. If | ||
| you're making a change to just the website, you can omit this section.* |
There was a problem hiding this comment.
Is this section really necessary? What do you think people have to write here?
There was a problem hiding this comment.
I get your point, but I want people to describe their testing strategy, partially as a way to verify that they have one (and encourage them to develop one, if they don't already)
| source changes) | ||
| * [ ] This is either a bugfix, a documentation update, or a new feature that has been explicitly | ||
| approved via an issue | ||
| * [ ] I ran the test suite locally (`npm run test`) and verified that it succeeded |
There was a problem hiding this comment.
I would change this point to:
I added test cases that back my changes and run it locally (
npm run test)
There was a problem hiding this comment.
There are situations in which new tests aren't required, so all I want to know is that they've run the test suite.
|
|
||
| ## Checklist | ||
|
|
||
| * [ ] I have read the contribution guidelines |
There was a problem hiding this comment.
It would be nice if you link to the contribution guidelines.
There was a problem hiding this comment.
Mostly people will interact with this in an edit view, where it will not display at as link.
| * [ ] I have read the contribution guidelines | ||
| * [ ] I have targeted this PR against the correct branch (`master` for website changes, `dev` for | ||
| source changes) | ||
| * [ ] This is either a bugfix, a documentation update, or a new feature that has been explicitly |
There was a problem hiding this comment.
When do I have to select this? Linking an issue should be enough, shouldn't it?
There was a problem hiding this comment.
We want people to know what kind of PRs we're looking for, which is what's described here.
Starting off pretty basic, just to address the most common complaints and make sure people write explanations.