-
Notifications
You must be signed in to change notification settings - Fork 4.7k
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 to repo #14271
add PR template to repo #14271
Conversation
Signed-off-by: Abigail McCarthy <mabigail@vmware.com>
cc: @xaleeks |
Codecov Report
@@ Coverage Diff @@
## master #14271 +/- ##
==========================================
+ Coverage 62.71% 65.57% +2.85%
==========================================
Files 913 925 +12
Lines 61050 69462 +8412
Branches 2018 2101 +83
==========================================
+ Hits 38287 45547 +7260
- Misses 18828 19964 +1136
- Partials 3935 3951 +16
Flags with carried forward coverage won't be shown. Click here to find out more.
|
|
||
### Please indicate you've done the following: | ||
|
||
- [ ] [Accepted the DCO](https://github.com/goharbor/harbor/blob/master/CONTRIBUTING.md#commit). Commits without the DCO will delay acceptance. |
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.
Maybe we can add some other items like testing passed or testing coverage etc. into this checklist?
Or just let the user make sure the CI pipeline is passed?
.github/PR_TEMPLATE.md
Outdated
### Please indicate you've done the following: | ||
|
||
- [ ] [Accepted the DCO](https://github.com/goharbor/harbor/blob/master/CONTRIBUTING.md#commit). Commits without the DCO will delay acceptance. | ||
- [ ] Updated the corresponding documentation in this repo or https://github.com/goharbor/website. |
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.
Thanks Abbie for creating the template. Assuming this one is for those PRs need document change. If the PR doesn't need document change, how submitter make the choice. And it would be better to change the document after this PR is merged.
One suggestion is to make it as a note only.
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.
Thats a good point. My first goal is to remind folks about updating the docs. I think my concern with making it a note, instead of a check mark is that there is no sign-off from a contributor.
What if we made it more open ended? something like,
- [ ] Considered the docs impact and opened a new docs issue or PR with docs changes if needed
My concern is that if we merge a PR without an option like this as a part of the checklist, then there will be no way to remember to open and docs issue or PR after the pr is merged. I'm interested to hear thoughts and feedback on this idea
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.
LGTM
Signed-off-by: Abigail McCarthy <mabigail@vmware.com>
Signed-off-by: Abigail McCarthy mabigail@vmware.com
Opening this PR as a Draft to start a discussion on adding a PR template to the repo. I'm not sure if this has come up before, but I think these templates can be very helpful to make sure folks fill in some basic info about what the PR is for and remind folks to do the required steps to get the PR merged that can get missed, like the DCO.
I'd also like to make sure we call out updating docs now that the docs are kept in a separate repo.
Is there anything else we should call out here? Like for creating release notes or how to run/pass tests?