feat(pr-template): initial work on template #149
Conversation
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
|
||
| --- | ||
|
|
||
| ## Type of Change |
There was a problem hiding this comment.
Debating if Type of Change should sit higher up in the Template, it is nice to know what exactly this change-type is before really digging into a PR.
There was a problem hiding this comment.
I'd err toward suggesting we don't include Type of Change, at least not in our first iteration. I'm not sure how close these categories will align with future work we do. And I wonder how much value it adds, verses the confusion it introduces.
There was a problem hiding this comment.
Seconding this. It seems to me that categorizing is what labels are for and then it's more of a triage task for reviewers. Might be better suited as a checklist item, below (e.g., "Is this PR labeled correctly?")
There was a problem hiding this comment.
We can hold off and I'll remove the section. Labels will work for now.
|
We could re-use the animated gif, specifically the second one, and embed it into our |
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| > __Pull-Request Reviewer__ should ensure the following | ||
|
|
||
| * [ ] Are Issues Linked Correctly? | ||
| * [ ] If, template updates do they align with [Google StyleGuide]()? |
There was a problem hiding this comment.
Do we want to link to the StyleGuide? If so which link?
There was a problem hiding this comment.
Yes, great to link to the Style Guide. Link to https://developers.google.com/style/
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
|
||
| * [ ] Are Issues Linked Correctly? | ||
| * [ ] If, template updates do they align with [Google StyleGuide]()? | ||
| * [ ] Did the PR receive :+1: from core-maintainers? |
There was a problem hiding this comment.
Check to see what roles we define for our project. Right now, the only official role we have is a PSC member. (This will likely be extended soon.)
I think we need to quantify support from core maintainers:
[ ] Did the PR receive at least one 👍 and no 👎 from core-maintainers?
There was a problem hiding this comment.
Making your line suggestion, we can always update this for new roles.
|
I love your work @mgan59 . Let's discuss in our meeting and then roll out. |
There was a problem hiding this comment.
I like this a lot, @mgan59! As someone who hasn't contributed a PR yet, I like how this gives me a really clear set of things to work through to make sure my PR is ready for review.
My only substantive suggestion is replacing the Type of Change section with a checklist item (see line comment). I do have some nit-picky style suggestions to make, though (the big thing: sentence case instead of title case) after high-level issues are resolved (or I can leave a bunch of line comments immediately, if you'd prefer).
Thank you!
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
|
||
| --- | ||
|
|
||
| ## Type of Change |
There was a problem hiding this comment.
Seconding this. It seems to me that categorizing is what labels are for and then it's more of a triage task for reviewers. Might be better suited as a checklist item, below (e.g., "Is this PR labeled correctly?")
|
@ddbeck Yeah saw the title case as I was editing, fixed that. Pushing updates. |
There was a problem hiding this comment.
Hey Morgan, we talked about this briefly in the meeting today. Since there hasn't been any other comments on the substance of this PR, this is nearly ready.
I'm suggesting a few very minor changes for capitalization, spelling, etc. If there are any questions about this, let me know, but it shouldn't be too exciting.
Once those comments are taken care of, we can get this merged! Thank you!
|
@Loquacity Lana, in one of our conversations you were suggesting git templates. You might want to review Morgan's proposal here. |
|
Thanks for the updates/suggestions @ddbeck made all of the changes. 😄 |
|
Viewable - Final Preview |
Purpose
Adding our initial PR Template so that we can improve our process for managing change-requests. Refers to issue #122
What changes were made?
Created the
.githhub/folder and generated the correspondingPULL_REQUEST_TEMPLATE.mdfile and placed the template into the folder.Verification
To view the RAW Version of the Template
The Default Look When PR Opened/Drafting
Quick Visual of the default look of the PR Template inside of the PR Panel when opened/draft-mode.
What the Process Looks Like to Fill-Out
Quick Visual of what it looks like to fill it out, once merged it will auto-populate.
Checklist