mirror of
https://github.com/SeedSigner/seedsigner.git
synced 2026-10-05 15:08:25 +00:00
Explicit description template; minor presentation reformatting; docs link fix
This commit is contained in:
@@ -1,14 +1,31 @@
|
||||
## Description
|
||||
|
||||
<i>
|
||||
### Problem or Issue being addressed
|
||||
|
||||
* What is the problem or issue you're addressing here?
|
||||
* Include any relevant background info, links to resources, BIPs, etc.
|
||||
* What is your solution?
|
||||
* Include key tech details to help reviewers understand your changes and rationale.
|
||||
* Any tradeoffs to discuss, follow-up steps, etc?
|
||||
<!--
|
||||
Describe the problem this PR solves.
|
||||
Include background context, links to relevant issues, BIPs, discussions, etc.
|
||||
-->
|
||||
|
||||
</i>
|
||||
### Solution
|
||||
|
||||
<!--
|
||||
Describe your approach and key technical implementation details.
|
||||
Explain why this approach was chosen.
|
||||
-->
|
||||
|
||||
### Additional Information
|
||||
|
||||
<!--
|
||||
Tradeoffs, follow-ups, limitations, or anything reviewers should be aware of.
|
||||
-->
|
||||
|
||||
### Screenshots
|
||||
|
||||
<!--
|
||||
Include screenshots for any new or modified screens.
|
||||
If omitted, explain why.
|
||||
-->
|
||||
|
||||
---
|
||||
|
||||
@@ -24,33 +41,39 @@ This pull request is categorized as a:
|
||||
|
||||
## Checklist
|
||||
|
||||
<b>I ran `pytest` locally</b>
|
||||
#### I ran `pytest` locally
|
||||
- [ ] All tests passed before submitting the PR
|
||||
- [ ] I couldn't run the tests
|
||||
- [ ] N/A
|
||||
|
||||
---
|
||||
|
||||
#### I included screenshots of any new or modified screens
|
||||
|
||||
<b>I included screenshots of any new or modified screens</b>
|
||||
Should be part of the PR description above.
|
||||
- [ ] Yes
|
||||
- [ ] No (explain why they were omitted)
|
||||
- [ ] No
|
||||
- [ ] N/A
|
||||
|
||||
---
|
||||
|
||||
#### I added or updated tests
|
||||
|
||||
<b>I added or updated tests</b>
|
||||
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
|
||||
|
||||
---
|
||||
|
||||
<b>I tested this PR hands-on on the following platform(s):</b>
|
||||
- [ ] Raspberry Pi OS [Manual Build](https://github.com/SeedSigner/seedsigner/blob/dev/docs/manual_installation.md)
|
||||
#### 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
|
||||
- [ ] Emulator
|
||||
|
||||
---
|
||||
|
||||
<b>I have reviewed these notes:</b>
|
||||
#### 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.
|
||||
|
||||
Reference in New Issue
Block a user