docs(contributing): refresh around the actual review flow and gates#377
Merged
Conversation
the old file had backslash-escaped code fences (every block rendered as literal text on github), called vouch pre-1.0 (1.2.1 is out), referenced empty issue templates, and carried none of the release checklist claude.md points at. restructured along the shape of a strong contributing doc: what happens to your pr (automated review + ci + maintainer decision, base on test), what we welcome, what we won't merge (now including the out-of-scope list — saas mode, ungated writes, storage-format swaps), before-opening checklist, the exact ci gate commands, test expectations (incl. the four registration sites for a new kb.* method), required pr contents, commit/title format with examples, and the maintainer release checklist with all four version sites. kept as-is: dev setup, env-var table, logging guidelines, style, security reporting.
markdownlint md040 wants a language on the fence; matches how the compile flow diagram was labelled after the #362 review.
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
github-actions
Bot
added
docs
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.
refreshes CONTRIBUTING.md, modeled on the strongest parts of a mature contributing doc (JSONbored/gittensory's) while staying truthful to vouch's actual flow.
fixes first: every code fence in the old file was backslash-escaped and rendered as literal ``` text on github; the intro still said pre-1.0; the issue-template link pointed at an empty directory; and the release checklist claude.md refers to was missing entirely.
new sections: what happens to your pr (automated review + ci + maintainer decision, base branches on test), what we welcome, an expanded what-we-won't-merge (now carrying the out-of-scope list), before-opening checklist, the exact ci gate commands, test expectations including the four registration sites for a new kb.* method, required pr contents (lowercase prose, no ai-attribution trailers), commit/title format with examples, and the maintainer release checklist with all four version sites. kept: dev setup, env vars, logging, style, security. second commit picks up the #376 coderabbit nit (fence language on the readme notification sample).