Started work on issue and PR templates #374
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jbcoe
reviewed
Apr 8, 2018
docs/pull_request_template.md
Outdated
|
|
||
| #### Where should the reviewer start? | ||
|
|
||
| #### Ideas that were considered and discarded |
There was a problem hiding this comment.
Maybe
#### Rationale / Background / Ideas considered and rejected [optional]
And perhaps a
#### Possible future work [optional]
Which would allow PR submitters to suggest follow-on work, which we could raise tickets for after appropriate discussion.
jbcoe
reviewed
Apr 8, 2018
docs/pull_request_template.md
Outdated
| @@ -0,0 +1,7 @@ | |||
| #### What does this PR do? | |||
|
|
|||
| #### Where should the reviewer start? | |||
jbcoe
reviewed
Apr 8, 2018
docs/pull_request_template.md
Outdated
| @@ -0,0 +1,7 @@ | |||
| #### What does this PR do? | |||
There was a problem hiding this comment.
This seems like standardising existing practice so is definitely good.
jbcoe
reviewed
Apr 8, 2018
docs/pull_request_template.md
Outdated
|
|
||
| #### Ideas that were considered and discarded | ||
|
|
||
| #### Relevant tickets |
There was a problem hiding this comment.
Definitely needed. I often forget this bit.
Probably worth adding
#### Closes [TicketNumbers]
too
There was a problem hiding this comment.
Definitely add the closes [ticketnumbers] part! I forget that too often.
jbcoe
reviewed
Apr 8, 2018
|
@jbcoe thanks for the review - happy to wait for the feedback from the others and add/change tomorrow |
ajbennieston
approved these changes
Apr 9, 2018
Following the review: sectioons for What does it do and what ticket it closes are universal. The rest are optional. Reduced the level of md headings
|
Looks good to me. @Twon: any comments? |
|
Yep, that looks good to me too. Go for it. |
Twon
approved these changes
Apr 10, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As explained in #373, a PR template doesn't exist and an issue template needs to be decided on
Please review and suggest changes