docs: add low-effort contribution examples guide (#497) - #535
Merged
El-swaggerito merged 1 commit intoJul 29, 2026
Merged
Conversation
6 tasks
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
docs/low-effort-contribution-examples.md, a worked-examples guide that documents the concrete shapes low-effort contributions take in PocketPay Mobile. For each category it shows a realistic poor example, explains why it falls short of the evaluation bar, and gives an improved alternative for the same work.The guide is the worked-example companion to the Meaningful Change Guide (which lists these shapes in brief) — it cross-links rather than duplicates, and reuses the repo's existing checklists and catalogues as the standard each improved example is measured against.
Closes #497
Changes
docs/low-effort-contribution-examples.md— new guide covering four categories, each as poor example → why insufficient → improved alternative:README.md— links the new guide from the Documentation section.Acceptance criteria
Notes
Documentation-only change; no application code is touched, so no tests, screenshots, or CI-affecting logic apply. All examples cross-link existing docs (Meaningful Change Guide, Self-Review Checklist, Test-First Contribution Guide, UI State Catalogue, Accessibility Checklist, and the two readiness checklists) to stay consistent with the repo's house style.