open-scd icon indicating copy to clipboard operation
open-scd copied to clipboard

Create a `PR` GitHub Template

Open pascalwilbrink opened this issue 9 months ago โ€ข 0 comments

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

pascalwilbrink avatar May 07 '24 10:05 pascalwilbrink