chore: Add a contributing guide. - #51
Merged
Merged
Conversation
Adds CONTRIBUTING.md, which asks contributors to open an issue and agree on the direction before writing code, explains why, and documents the conventions for issues, code, commits, and pull requests. The README gains a short section that points to it. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014C8sbpnyEX9WQ3C3BP1KQ2
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
1 participant
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.
What
Adds
CONTRIBUTING.mdand a short Contributing section in the README that points to it.The guide asks contributors to open an issue and agree on the direction before writing code, and explains why: a pull request represents hours of someone's time, declining one is painful for both sides, and the usual reason is direction rather than code quality. It then covers what "agreed" means (a maintainer confirms goal and approach in the issue), how to take on an existing issue, what happens to a pull request that arrives without an issue, which details count as user-facing and are settled in the issue (schema, CLI, defaults, output, diagnostics), the issue templates, and the expected response time.
Further sections cover field reports and documentation contributions, the code conventions (tests with every change, a reproducing test for every bug fix, readable code,
make qa, schema snippets), a stance on AI-assisted contributions, and the pull request conventions: one issue per pull request, conventional-commit titles because we squash-merge, no history rewriting once pushed, and the review tone.Why
Three external contributors have been active in the last two months, one of them offering to implement an issue, and the repository had no document that tells them how a contribution works here. The conventions lived only under
.claude/rules/, where a human contributor does not look. This is the "quick win" part of #13; where shared community resources (skills, language packs) should live remains open there and is deliberately not covered by the guide.Notes
make qapasses.Refs #13
🤖 Generated with Claude Code
https://claude.ai/code/session_014C8sbpnyEX9WQ3C3BP1KQ2