-
Notifications
You must be signed in to change notification settings - Fork 9.8k
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
docs: Added initial PR template with directions for doc only changes and squash merges [no ci] #7700
docs: Added initial PR template with directions for doc only changes and squash merges [no ci] #7700
Conversation
Nice, I be interested to see if everyone else think it's good. I would like to also add that I've been adding 'review complexity' manually, but it be good to get the submitter to indicate their subjective take on how hard it would be to review their PR. The idea is that at the very least it would speed up my manual assessment and labeling of PR... and also that later we can add some automation to do the PR complexity label automagically. Did a bit of research and found this option out:
We are currently using actions/labeler for labeling PRs but it can only do it based on content and not on PR title and description.
In this case however to keep this PR complexity down, don't try to add this automation in. We just need to make sure we can add a regex matching process for it in the future somehow. Approving, but waiting for others to see if we need to flesh it out. I think it's good to keep this simple however. |
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.
It's better to add a CONTRIBUTING file in the repo and the PR template to just reference the file:
Before opening the PR make sure to read CONTRIBUTING
I made some modifications following everyone's advice.
|
I took out most of the fluff from the PR template and moved it to CONTRIBUTING |
Co-authored-by: compilade <[email protected]>
It would be nice if there was a brief explanation of |
@slaren I'm not sure @nicolasperez19 would be familiar enough about these, so you may want to add some pointers where he should read up to write about it. I've adjusted the PR a bit to include GG's and my preferred changes. As you got some extra feedback, I'll hold back again from merging to give @nicolasperez19 a chance to respond. |
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.
It's a good first step - we'll expand after we merge it. Thanks
@nicolasperez19 now merged in. Feel free to explore slaren suggestion in a separate PR |
Summary
Changes Made
README
so that collaborators follow the PR template when sending a PR[no ci]
to the commit title<module>:<commit title> (#<issue_number>)
when squashing multiple commits on mergeAdditional Information