chore(github): add pull request template#3044
Conversation
- for the first commit, just steal the Ionic team's
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| - [ ] Build (`npm run build`) was run locally and any changes were pushed | ||
| - [ ] Unit tests (`npm test`) were run locally and passed | ||
| - [ ] E2E Tests (`npm run test.karma.prod`) were run locally and passed | ||
| - [ ] Prettier (`npm run format`) was run locally and passed |
There was a problem hiding this comment.
Prettier is currently npm run prettier (but I would not be opposed to making it npm run format):
https://github.com/ionic-team/stencil/blob/252415a5cc94cad9ea0a5eddb73bae32d1845c96/package.json#L39
There was a problem hiding this comment.
Bah, that's my fault. In a former life I named the script 'format'. Let me change that realllll quick
|
|
||
| <!-- Please try to limit your pull request to one type, submit multiple pull requests if needed. --> | ||
|
|
||
| Please check the type of change your PR introduces: |
There was a problem hiding this comment.
A side effect of using a task list here is that all PRs will have "8 of 14 tasks" completed.
There was a problem hiding this comment.
I don't love it TBH. It looks like that this is up for discussion as a part of the beta for the new Task Lists implementation - I'm seeing feedback on the GitHub feedback board around the very same thing. I really like the suggestion there, hopefully it gets implemented 🤞
I'm open to alternatives too/in the interim. I couldn't find any way to 'opt-out' of the current behavior, other than converting these checkboxes to bulleted lists 😦
splitinfinities
left a comment
There was a problem hiding this comment.
This is huge! Thank you so much for doing this!!
Meta: This is the current shape I have for the PR template. It would apply to both the core stencil team and external contributors, as GH does not have a way to differentiate the two ATM. LMK what yinz think
Pull request checklist
Please check if your PR fulfills the following requirements:
npm run build) was run locally and any changes were pushednpm test) were run locally and passednpm run test.karma.prod) were run locally and passednpm run format) was run locally and passedPull request type
Please check the type of change your PR introduces:
What is the current behavior?
There is no template, which allows for a greater spread of quality in PR summaries we get
GitHub Issue Number: N/A
What is the new behavior?
Does this introduce a breaking change?
Testing
Other information
N/A