Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Add PR Template #441

Merged
merged 3 commits into from
Sep 14, 2023
Merged

Conversation

newtonick
Copy link
Collaborator

No description provided.

@kdmukai
Copy link
Contributor

kdmukai commented Aug 16, 2023

Random thoughts:

  • Add something like a Background / Problem: basically what's the current state of things and why does it need to change?
  • Describe the change.
  • Explain any rationale if there's a deviation from the typical approach or if something was refactored.
  • Within the testing section: If there are any new screens, add them to the screenshot generator or explain why they are omitted (e.g. too complicated, not yet possible in the screenshot generator). Include relevant screenshots in your PR description.
  • Maybe also note other tips: "Try to keep your changes limited in scope; if you uncover other issues or improvements along the way, ideally submit those as a separate PR" (yes, I am the worst offender when it comes to PR scope creep...).

@newtonick newtonick marked this pull request as ready for review August 23, 2023 01:34
@jdlcdl
Copy link

jdlcdl commented Aug 23, 2023

This has my support.

@newtonick
Copy link
Collaborator Author

I'm merging this as is to start getting feedback so we can make more iterations if this proves to be helpful.

@newtonick newtonick merged commit 0c83196 into SeedSigner:dev Sep 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Merged Not Yet Released
Development

Successfully merging this pull request may close these issues.

3 participants