open-scd
open-scd copied to clipboard
Create a `PR` GitHub Template
To make our life more simple, we can make use of a PR
Template in GitHub
Example:
## Hi, i just made a pull request! ๐
<!-- Briefly tell us what this pull request is all about -->
## Changes Made
<!-- What did you do? -->
- [ ] Fixed some typos in the docs ๐
- [ ] Added some cool new tests ๐งช
- [ ] Made the code less spaghetti-like ๐
- [ ] Squashed some pesky bugs ๐
- [ ] Sped things up a bit โฑ๏ธ
- [ ] Cleaned up the codebase a bit ๐งน
- [ ] Did some other stuff:
<!-- Fill in -->
## Related Issue
<!-- Got an issue number for this? -->
## Screenshots (if needed)
<!-- Any visuals to show off your changes? -->
## Checklist
<!-- Make sure you've covered all the bases -->
- [ ] Updated the docs ๐
- [ ] Wrote some tests ๐งช
- [ ] Code looks good to go โ
- [ ] Reviewed my own code ๐
- [ ] Left comments where things might get hairy ๐ฌ
- [ ] Updated the README if needed ๐
- [ ] No new warnings or errors ๐ซโ ๏ธ
- [ ] Tests pass with my changes โ
- [ ] Checked for any sensitive info or oopsies ๐คซ
- [ ] Gave it a spin on my local setup ๐ง
- [ ] All my commits are signed off โ๏ธ
## Reviewers
<!-- Tag anyone specific who should take a look -->
## Signed-off-by
<!-- Your John Hancock here -->
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository
Acceptance criteria:
- [ ] PR template exists in
.github
folder