-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Github pull_request_template.md to include README update, remove Task section #133
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the Task section removal because it's redundant with Linear integration. Do you add it to the PR title as a prefix? The only advantage there is visibility in git log, which I don't think I ever use.
I added it as a suffix. Is that good enough, @reedrolemodel? |
The format that we have typically aimed for is described here. https://github.com/RoleModel/BestPractices/blob/master/git/commit-messages.md I've always done |
@@ -15,6 +11,10 @@ What changed in this PR? | |||
* [ ] Change 2 | |||
* [ ] ... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thoughts on removing these extras? I always need to delete them and add my own
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hitting Enter after a todo adds a new one automatically, so I agree these are unnecessary.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
though, I guess this is the important file to make the change in. Isn't it?
* [ ] Change 2 | ||
* [ ] ... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* [ ] Change 2 | |
* [ ] ... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
apply to generator template also
My point is I don't need it. The Github PR number is appended by Squash and merge. If I need to look up the task, I can follow the link in my git client to the PR and then follow the link to Linear from there. |
That's how we do it too, except the PR number is appended automatically by Squash merges. For example:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1 for removing task list items after Change 1
. Otherwise
* [ ] Change 2 | ||
* [ ] ... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* [ ] Change 2 | |
* [ ] ... |
Why?
Why were the changes needed? What issues were the changes addressing?
(Note: some changes may seem unrelated to the ticket, this is a great place to explain further.)
Linear automatically links to the PR when referenced in the PR name; READMEs are hard to remember to update to confirm they get updated upon PR creation/review
What Changed
What changed in this PR?
Screenshots
If any UI changes need to be shown off, please add screenshots here.