chore: update github PR template [INFENG-600] #9098
Conversation
✅ Deploy Preview for determined-ui canceled.
|
JComins000
force-pushed
the
jcom/INFENG-600/PR-template-cleanup
branch
4 times, most recently
from
133a641
to
f37bc1f
Compare
JComins000
force-pushed
the
jcom/INFENG-600/PR-template-cleanup
branch
from
f37bc1f
to
a99caff
Compare
.github/pull_request_template.md
Outdated
|
|
||
| Check the "Example Commit Body" for conventional commit semantics. | ||
| For breaking changes, please lead with "BREAKING CHANGE:". |
There was a problem hiding this comment.
Previously, this "breaking change" part suggested the PR author to call out the breaking changes in the "description" section (which is now apparently called "commentary").
Now this reads as if you're supposed to put "BREAKING CHANGE: " into the PR title which is not the established process.
There was a problem hiding this comment.
Good point! I'll move that part to the other section. I can keep "description" as well. It looked to be redundant with commentary.
There was a problem hiding this comment.
ok, yea, I'd personally keep description and get rid of the optional commentary instead of promoting commentary in place of description because I don't see a point in "swapping" these two.
JComins000
force-pushed
the
jcom/INFENG-600/PR-template-cleanup
branch
from
2945c3c
to
d3b49a8
Compare
JComins000
changed the title
| Jira ticket, e.g. "[DET-1234]". When squash-and-merging, copy this directly | ||
| into the description field. | ||
| ## PR TITLE (Commit Body) | ||
| When squash-and-merging, copy this directly into the description field. |
There was a problem hiding this comment.
| When squash-and-merging, copy this directly into the description field. | |
| When squash-merging, this will be used as the commit message. |
Users don't need to copy the text in - it'll already be there.
| into the description field. | ||
| ## PR TITLE (Commit Body) | ||
| When squash-and-merging, copy this directly into the description field. | ||
| Check the "Example Commit Body" for conventional commit semantics. |
There was a problem hiding this comment.
Maybe include a link to the actual spec, too?
| Check the "Example Commit Body" for conventional commit semantics. | |
| Check the "Example Commit Body" for conventional commit semantics. For more details, https://www.conventionalcommits.org/en/v1.0.0/#summary |
| --> | ||
| ## Ticket | ||
| <!--- | ||
| A reference to the Jira ticket or Github issue. e.g. "[DET-1234]". |
There was a problem hiding this comment.
An example of both would likely be useful
| A reference to the Jira ticket or Github issue. e.g. "[DET-1234]". | |
| A reference to the Jira ticket or Github issue. e.g. "[DET-1234]" or #123. |
Ticket
INFENG-600
Description
Rewrote some of the PR template; I'm very open to suggestions.
Test Plan
Checklist
docs/release-notes/.See Release Note for details.