diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6a61b2dd..13c1912a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,8 +1,33 @@ ## Description -_Describe the change simply. Provide a reason for the change._ +### Problem or Issue being addressed -_Include screenshots of any new or modified screens (or at least explain why they were omitted)_ + + +### Solution + + + +### Additional Information + + + +### Screenshots + + + +--- This pull request is categorized as a: @@ -12,21 +37,51 @@ This pull request is categorized as a: - [ ] Documentation - [ ] Other +--- + ## Checklist -- [ ] I’ve run `pytest` and made sure all unit tests pass before submitting the PR - -If you modified or added functionality/workflow, did you add new unit tests? - -- [ ] No, I’m a fool -- [ ] Yes +#### I ran `pytest` locally +- [ ] All tests passed before submitting the PR +- [ ] I couldn't run the tests - [ ] N/A -I have tested this PR on the following platforms/os: +--- -- [ ] Raspberry Pi OS [Manual Build](https://github.com/SeedSigner/seedsigner/blob/dev/docs/manual_installation.md) +#### I included screenshots of any new or modified screens + +Should be part of the PR description above. +- [ ] Yes +- [ ] No +- [ ] N/A + +--- + +#### I added or updated tests + +Any new or altered functionality should be covered in a unit test. Any new or updated sequences require FlowTests. +- [ ] Yes +- [ ] No, I’m a fool +- [ ] N/A + +--- + +#### I tested this PR hands-on on the following platform(s): +- [ ] Raspberry Pi OS [Manual Build](https://github.com/SeedSigner/seedsigner/blob/dev/docs/raspberry_pi_os_build_instructions.md) - [ ] [SeedSigner OS](https://github.com/SeedSigner/seedsigner-os) on a Pi0/Pi0W board -- [ ] Other +- [ ] Emulator +--- -Note: Keep your changes limited in scope; if you uncover other issues or improvements along the way, ideally submit those as a separate PR. The more complicated the PR the harder to review, test, and merge. +#### I have reviewed these notes: +* Keep your changes limited in scope. +* If you uncover other issues or improvements along the way, ideally submit those as a separate PR. +* The more complicated the PR, the harder it is to review, test, and merge. +* We appreciate your efforts, but we're a small team of volunteers so PR review can be a very slow process. +* Please only "@" mention a contributor if their input is truly needed to enable further progress. + +- [ ] I understand + +--- + +Thank you! Please join our [Devs' Telegram group](https://t.me/seedsigner_new_devs) to get more involved. \ No newline at end of file