docs: add CONTRIBUTING.md and link it from READMEs - #114
Merged
Merged
Conversation
Consolidate contribution conventions scattered across the README, SUPPORT.md, SECURITY.md, and docs/guide/quality-gates.md into a single CONTRIBUTING.md: development environment, source build, quality gates, code constraints, commit style, pull request process with CI jobs, docs preview, and community/license notes. Link the new page from the English, Simplified Chinese, and Japanese READMEs.
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
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.
Summary
Adds a root-level
CONTRIBUTING.mdand links it from the English, Simplified Chinese, and Japanese READMEs.The repository previously had no CONTRIBUTING file; contribution guidance was scattered across the README (4 bullet points),
docs/guide/quality-gates.md,SUPPORT.md, andSECURITY.md. The new page consolidates these into one entry point for new contributors without duplicating detail — deep dives remain linked.Contents
CCCC_HOMEboundary), plus the private-disclosure pointer toSECURITY.mdrust-toolchain.toml), Node 24 (CI pin 24.19.0), Python 3.11+ (tooling only), and the source run commandweb/docs/scripts+testsmap pointing at the architecture referencequality_gate.sh fast|full,pre_commit_checks.sh --dry-run, individual commands (matching CI invocations exactly), the serial daemon-test note,CCCC_CARGO_JOBS, the Connect browser acceptance gate, and the docs-contract-test caveatunsafe_codeforbid; clippyunwrap_used/todo/dbg_macrodenied) and the design-boundary stance on file lengthquality-gates.mdconfig.tsnavigation requirementVerification
.github/workflows/ci.yml,rust-toolchain.toml, and the[workspace.lints]table inCargo.tomluv run --no-project --with pytest --with pyyaml python -m pytest -q— 121 passedscripts/quality_gate.sh fast— all impacted checks passed (8s)