Create pull_request_template.md #1307
Conversation
joshkay10
requested review from
mboudreau,
thombergs,
krazziekay,
rachellerathbone,
atrigueiro and
gxueatlassian
.github/pull_request_template.md
Outdated
| @@ -0,0 +1,5 @@ | |||
| # What's in this PR? | |||
There was a problem hiding this comment.
Shall we have a # Why or Context?
There was a problem hiding this comment.
I accept your offer
.github/pull_request_template.md
Outdated
|
|
||
| # Why | ||
|
|
||
| # Whats Next? |
There was a problem hiding this comment.
What's next should be the last section, how this was tested should be before that
.github/pull_request_template.md
Outdated
|
|
||
| # Whats Next? | ||
|
|
||
| # How has this been tested? |
There was a problem hiding this comment.
Probably need an "Added feature flags" and an "Affected issues" section
|
You're on a roll, do you think we should add an issue template as part of this PR as well? |
.github/pull_request_template.md
Outdated
|
|
||
| # Whats Next? | ||
|
|
||
| # How has this been tested? |
There was a problem hiding this comment.
Does this section tell the reviewers how to test the changes in the PR. If so, shouldn't this be How to test?
There was a problem hiding this comment.
added a helpful hint under the header
helpful hints
Added line breaks
.github/pull_request_template.md
Outdated
| @@ -0,0 +1,7 @@ | |||
| # What's in this PR? | |||
|
|
|||
| # Why | |||
There was a problem hiding this comment.
I think this section should be the first one
What's in this PR?
I've put in bare bones stuff for A PR Template. All it will do is load the
.github/pull_request_template.mdcontents into the PR comments section when a new PR is created.Why
During our coding conventions chit chat the idea was suggested.
Added feature flags
NA
Affected issues
NA
How has this been tested?
Your testing it right now, your in the test!
Whats Next?
Iterate iterate iterate. likely the first one will be only kinda helpful and will need to be simplified and adjusted