-
Notifications
You must be signed in to change notification settings - Fork 4
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
Add PR template for BPG #97
Conversation
Does reprex include screenshots of the results? It might be good to phrase the requirements for the test results section more generally, then suggest reprex as a helpful tool. Something like
|
Good idea. Reprex includes a screenshot as well so I think your instructions sound good |
.github/pull_request_template.md
Outdated
|
||
- [ ] The name of the branch is meaningful and well formatted following the [standards](https://confluence.mednet.ucla.edu/display/BOUTROSLAB/Code+Review+Best+Practice+on+GitHub+-+Check+List), using [AD_username (or 5 letters of AD if AD is too long)]-[brief_description_of_branch]. | ||
|
||
- [ ] I have added the major changes included in this pull request to the `NEWS` under the next release version or unreleased, and updated the date. |
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.
One last thing. We should probably also mention DESCRIPTION
. I'm thinking something like "I have also updated the version number and date in DESCRIPTION
.
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'm actually a bit unsure of the workflow here. Do we update the version every PR or do we have multiple bug fixes in 7.0.X
?
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.
Right, see this discussion for versioning best practices. I think the main thing here is that DESCRIPTION
must follow any changes to NEWS
. The date will change just about every PR, and the version will likely change regularly enough that it's worth mentioning.
.github/pull_request_template.md
Outdated
@@ -20,6 +20,8 @@ | |||
|
|||
- [ ] I have added the major changes included in this pull request to the `NEWS` under the next release version or unreleased, and updated the date. | |||
|
|||
- [ ] I have updated the version number in `DESCRIPTION` according to [semantic versioning](https://semver.org/) rules. |
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.
Hate to be pedantic, but I wonder if we should combine these for clarity. I see it all as one step, as the date and version number should be consistent between NEWS
and DESCRIPTION
. I'm hoping that we can teach new contributors through this checklist. If we get this right, we'd avoid a lot of PR review comments.
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 merged the NEWS and DESCRIPTION lines
Description
Adds BPG specific PR template
Closes #77
Checklist
.png
, .jpeg
),.pdf
,.RData
,.xlsx
,.doc
,.ppt
, or other non-plain-text files. To automatically exclude such files using a .gitignore file, see here for example.main
branch protection rule following the github standards before opening this pull request.CHANGELOG.md
under the next release version or unreleased, and updated the date.