Add PR template and note to README about said template

This commit is contained in:
Niko 2025-07-29 17:55:46 -07:00
parent 2cdb117101
commit 6de1119a79
No known key found for this signature in database
2 changed files with 53 additions and 33 deletions

17
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,17 @@
# Description
This pull request implements xyz or fixes abc.
closes #(issue)
closes #(another issue)
## Checklist
Please put an x inside each checkbox to indicate that you've read and followed it: `[ ]` -> `[x]`
- [ ] I/we have not leveraged GenAI to create the proposed changes.
- [ ] I/we have performed a self-review of added code.
- [ ] I/we have written code that is legible and maintainable by others.
- [ ] I/we have commented the added code, particularly in hard-to-understand areas.
- [ ] I/we have made any necessary changes to documentation.
- [ ] I/we have run `cargo fmt` and `cargo clippy`.

View file

@ -100,4 +100,7 @@ work out of the box.
[Unlicense](LICENSE) [Unlicense](LICENSE)
tl;dr: public domain tl;dr: code is in the public domain
[the PR template](./.github/PULL_REQUEST_TEMPLATE.md) is derived from
[GoToSocial's PR template](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/.gitea/pull_request_template.md)