Skip to content

Capture corrections in CONTRIBUTING #265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gumclaw merged 1 commit into from
Jun 8, 2026
Merged

Capture corrections in CONTRIBUTING #265

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,3 +133,7 @@ A great bug report includes:
## 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.
Comment on lines 133 to +139

@greptile-apps greptile-apps Bot Jun 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 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!

Loading