Skip to content

docs(contributing): "fix it or flag it — never ignore" norm#47

Merged
dzuluaga merged 2 commits into
mainfrom
docs/contributing-fix-or-flag
Jul 11, 2026
Merged

docs(contributing): "fix it or flag it — never ignore" norm#47
dzuluaga merged 2 commits into
mainfrom
docs/contributing-fix-or-flag

Conversation

@dzuluaga

Copy link
Copy Markdown
Contributor

Adds a short norm to CONTRIBUTING.md: if you notice something broken while working — even outside your change or not your ticket — fix it if it's small and safe, otherwise open an issue or leave a comment. Never silently ignore it.

Guardrail is baked in so it doesn't cause scope creep: keep PRs focused, use the issue tracker as the pressure valve (small fix inline, spin the rest into its own issue). Also ties it to running the thing — these defects (a hardcoded stepper, a page that doesn't refresh) are invisible in unit tests and obvious the moment you drive the feature. Adds one matching pre-PR checklist item.

Motivated by the #42 review, where several defects only surfaced by driving the running demo end-to-end.

🤖 Generated with Claude Code

dzuluaga and others added 2 commits July 10, 2026 20:42
If you notice something broken while working — even outside your change — fix it
if it's small and safe, otherwise open an issue or leave a comment. Never silently
ignore a defect you saw. Guardrail: keep PRs focused (issue tracker is the pressure
valve), and note that you find these by running the thing, not just green tests.
Adds a matching pre-PR checklist item.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019QxYCu2K49F4o1CZguC2NF
Signed-off-by: Diego Zuluaga <dfzuluaga@gmail.com>
…en, not just complete

The "run it" wording let the real gap through: visual testing that only asks
"does the happy path finish?" misses screens that render but LIE — a hardcoded
stepper claiming steps the buyer never did, a page stuck "Payment locked" for a
paid order. Both passed a click-through; both are obvious the moment you read the
screen. Reframe: running it means reading every screen critically — "does every
screen tell the truth?", not "did it complete?". Adds a matching checklist item
for UI/flow changes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019QxYCu2K49F4o1CZguC2NF
Signed-off-by: Diego Zuluaga <dfzuluaga@gmail.com>
@dzuluaga dzuluaga merged commit 2f6161d into main Jul 11, 2026
3 checks passed
@dzuluaga dzuluaga deleted the docs/contributing-fix-or-flag branch July 11, 2026 04:03
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