docs: soften README contribution guidance#33
Merged
Conversation
Reframe the spec-change callout per Junjie's feedback: drop the top-of-README warning banner and replace it with a Contributing section that distinguishes normative spec changes (discuss via issue, maintainer lands) from non-normative changes (examples, conformance, docs) where community PRs are welcome. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
evalstate
approved these changes
Jun 21, 2026
mindpower
approved these changes
Jun 21, 2026
Collaborator
There was a problem hiding this comment.
Thanks Guha!
The clear split between normative and non-normative contributions is perfect.
To answer your question about where the line sits:
-
I think
adr/(Architecture Decision Records) should probably sit on the "maintainer-driven / issue-first" side, since those represent foundational design consensus. -
conformance/is great to leave open to the community, especially so they can contribute test cases alongside their reference examples.
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
3 participants
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.
Reframes the contribution guidance in the README per Junjie's feedback.
Why: the top-of-README "Proposing a change" warning banner was doing its job, but risked signaling that all PRs are unwanted, which could chill the community involvement we want.
What changed:
## Contributingsection that distinguishes two cases:spec/ard.md+spec/schemas/) — discuss via an issue first; a maintainer lands the change.@mindpower — does this strike the right balance? Happy to adjust where the normative line sits (e.g. whether
conformance/oradr/should be maintainer-only too).