Skip to content

docs: add CONTRIBUTING guide and PR template - #140

Merged
jvsena42 merged 4 commits into
mainfrom
docs/contributing-guidelines
Jul 20, 2026
Merged

docs: add CONTRIBUTING guide and PR template#140
jvsena42 merged 4 commits into
mainfrom
docs/contributing-guidelines

Conversation

@jvsena42

Copy link
Copy Markdown
Owner

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 at TransactionViewModelTest and fakes/FakeFlorestaRpc.kt), updating journeys/testTags for UI changes (real journey snippet + the two testTag gotchas), self-review + local detekt/lintDebug/test gates, 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 ## Contributing section linking the guide.
  • .github/pull_request_template.md (new) — checklist mirroring the guidelines.

Docs/config only — no build impact.

Checklist

  • Commits are atomic and follow conventional style
  • Unit tests added/updated for business-logic changes — N/A (docs only)
  • Journeys and journeys/README.md testTags updated for UI changes — N/A (no UI change)
  • ./gradlew detekt, ./gradlew lintDebug, and ./gradlew test pass locally — N/A (docs only, no build impact)
  • I have self-reviewed my own diff

UI changes

N/A

🤖 Generated with Claude Code

jvsena42 and others added 4 commits July 20, 2026 16:09
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
jvsena42 enabled auto-merge (rebase) July 20, 2026 19:15
@jvsena42
jvsena42 disabled auto-merge July 20, 2026 19:16
@jvsena42
jvsena42 enabled auto-merge (squash) July 20, 2026 19:16
@jvsena42
jvsena42 merged commit 1d35ef2 into main Jul 20, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant