Capture corrections in CONTRIBUTING

[gumclaw]

Adds a short section to the contributing guide: when a maintainer corrects your approach in review — a convention, workflow, or undocumented gotcha — propose an edit to this guide in the same PR so the correction is captured once and never has to be repeated. Keeps the guide compounding instead of relearning the same lessons.

---

^{Need help on this PR? Tag /codesmith with what you need. Autofix is disabled.}

---

Note

Low Risk
Documentation-only change with no runtime, security, or data-handling impact.

Overview
Adds a new When you're corrected, fix the docs section to CONTRIBUTING.md, placed after the License section.

It tells contributors that when review feedback surfaces an undocumented convention, workflow, or gotcha, they should update this guide in the same PR or a quick follow-up—not only change the code—so the guide compounds and the same correction is not repeated.

^{Reviewed by Cursor Bugbot for commit 02ab611. Bugbot is set up for automated code reviews on this repo. Configure here.}

[greptile-apps]

Greptile Summary

This PR adds a short "When you're corrected, fix the docs" section to CONTRIBUTING.md, asking contributors to propose a guide update in the same PR whenever a maintainer points out an undocumented convention or workflow during review.

• New section content: Clear, actionable guidance that keeps the contributing guide self-compounding — corrections discovered in review become permanent documentation rather than repeated tribal knowledge.
• Placement: The new section is appended after the ## License block; conventionally the license statement closes the document, so swapping the order (new section above, License last) would follow standard practice.

Confidence Score: 5/5

Documentation-only change with no code impact; safe to merge as-is.

The change is four lines of prose added to a markdown guide. The only noteworthy detail is that the new section lands after the License block rather than before it, which is a cosmetic ordering preference and does not affect correctness or behavior in any way.

No files require special attention.

Important Files Changed

Filename	Overview
CONTRIBUTING.md	Adds a 'When you're corrected, fix the docs' section encouraging contributors to capture review corrections in the guide; minor placement concern (appended after the License section rather than before it).

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Contributor opens PR] --> B[Maintainer reviews code]
    B --> C{Correction needed?}
    C -- No --> D[PR approved & merged]
    C -- Yes --> E[Maintainer flags convention / gotcha]
    E --> F[Contributor fixes the code]
    F --> G[Contributor proposes CONTRIBUTING.md edit\nin same PR or fast follow-up]
    G --> H[Guide captures the lesson]
    H --> B

Loading

_{Reviews (1): Last reviewed commit: "Capture corrections in CONTRIBUTING" | Re-trigger Greptile}

[greptile-apps]

The new section is appended after the ## License block, which conventionally ends a contributing guide. License terms being sandwiched before other content can feel out of place to readers scanning the document. Moving the new section above ## License keeps the license as the closing statement.

Suggested change

	## License
	By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE.md).
	## When you're corrected, fix the docs
	If a maintainer corrects your approach in review — a convention, a workflow, a gotcha that isn't written down — don't just fix the code. Propose an edit to this guide in the same PR (or a fast follow-up) so the correction is captured once and never has to be repeated. The contributing guide should get a little smarter every time someone gets corrected.
	## When you're corrected, fix the docs
	If a maintainer corrects your approach in review — a convention, a workflow, a gotcha that isn't written down — don't just fix the code. Propose an edit to this guide in the same PR (or a fast follow-up) so the correction is captured once and never has to be repeated. The contributing guide should get a little smarter every time someone gets corrected.
	## License
	By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE.md).

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!