What the developer wrote
Authored by kdmukai
Update PR template
What changed, and why it matters
This commit only updates the GitHub pull request template, which is a form contributors fill out when submitting code changes. It does not change any actual application code, so it has no direct security impact on the SeedSigner software or its users.
No security action needed. This is a normal repository process/documentation change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies .github/pull_request_template.md only. It reorganizes and expands the checklist and description prompts for contributors (e.g., adding sections for screenshots, test coverage, platform testing, and contributor notes). No source code, build scripts, dependencies, or configuration affecting runtime behavior were changed.
Changed components
.github/pull_request_template.mdInspect captured patch +40 / −8
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 6a61b2d..b3f4e0f 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,8 +1,16 @@
## Description
-_Describe the change simply. Provide a reason for the change._
+<i>
-_Include screenshots of any new or modified screens (or at least explain why they were omitted)_
+* 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?
+
+</i>
+
+---
This pull request is categorized as a:
@@ -12,21 +20,45 @@ 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
+<b>I ran `pytest` locally</b>
+- [ ] All tests passed before submitting the PR
+- [ ] I couldn't run the tests
+- [ ] N/A
-If you modified or added functionality/workflow, did you add new unit tests?
-- [ ] No, I’m a fool
+<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)
+- [ ] N/A
+
+
+<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
-I have tested this PR on the following platforms/os:
+<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)
- [ ] [SeedSigner OS](https://github.com/SeedSigner/seedsigner-os) on a Pi0/Pi0W board
-- [ ] Other
+- [ ] Emulator
+
+
+<b>I have reviewed these notes:</b>
+* 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
+---
-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.
+Thank you! Please join our [Devs' Telegram group](https://t.me/seedsigner_new_devs) to get more involved.
\ No newline at end of file
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.