docs: add CONTRIBUTING guide and PR template - #140
Merged
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
jvsena42
enabled auto-merge (rebase)
July 20, 2026 19:15
jvsena42
disabled auto-merge
July 20, 2026 19:16
jvsena42
enabled auto-merge (squash)
July 20, 2026 19:16
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a human-facing external-contributor guide, links it from the README, and adds a GitHub PR template so the checklist auto-populates on every PR. Structured so future code-review bots can consume it too.
CONTRIBUTING.md(new) — covers atomic/conventional commits (with real examples + the commit types actually used here), unit tests for business logic (fakes over mocks; points atTransactionViewModelTestandfakes/FakeFlorestaRpc.kt), updating journeys/testTags for UI changes (real journey snippet + the two testTag gotchas), self-review + localdetekt/lintDebug/testgates, and requiring screenshots/videos for UI changes. Opens with a note that the project is maintained solo, in free time, so reviews may take a while.README.md— new## Contributingsection linking the guide..github/pull_request_template.md(new) — checklist mirroring the guidelines.Docs/config only — no build impact.
Checklist
journeys/README.mdtestTags updated for UI changes — N/A (no UI change)./gradlew detekt,./gradlew lintDebug, and./gradlew testpass locally — N/A (docs only, no build impact)UI changes
N/A
🤖 Generated with Claude Code