Repository navigation
docs: add CONTRIBUTING.md (build from source, running tests) - #79
Merged
Merged
Conversation
Add a contributor guide covering prerequisites (Rust 1.83 per rust-toolchain, Python 3.9-3.13, maturin), building from source with maturin develop and the Makefile targets, running tests (test_contract, test_rfc_corpus and friends), regenerating the RFC corpus, linting (cargo fmt/clippy, mypy, ruff and which are enforced vs advisory), the Test CI workflow gates, and DCO sign-off. Link it from Readme.md. Closes #51 Signed-off-by: yuriyryabikov <22548029+kurok@users.noreply.github.com>
The first draft was generated against a stale checkout (3.9–3.13, 8x). Align with master: requires-python >= 3.11, matrix 3.11–3.14, benchmark floor 7x. Signed-off-by: yuriyryabikov <22548029+kurok@users.noreply.github.com>
kurok
force-pushed
the
fix-issue-51-contributing-docs
branch
from
June 12, 2026 20:58
ac951eb to
e51ede0
Compare
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 contributor guide (
CONTRIBUTING.md) at the repo root and links it fromReadme.md. Content is verified against the actual repo files (Makefile,pyproject.toml,rust-toolchain,.github/workflows/test.yml,.github/scripts/check_benchmark.py,tests/) — no invented commands.Covers:
rust-toolchain;cargo auditruns on stable), Python 3.9–3.13 (requires-python >= 3.9, CI matrix), maturin build backend.pip install maturin,maturin develop(debug) /maturin develop --release(benchmarking), plus theMakefiletargets (make install,make install-test,make test,make benchmark).make test(excludes benchmark), the suites present (test_contract.pyAPI contract,test_rfc_corpus.pyRFC-feature corpus, and the focused tests), and regenerating the RFC corpus viapython tests/generate_rfc_corpus.py.cargo fmt(enforced),cargo clippy/mypy(advisory),ruff(advisory).Testworkflow gates PRs: lint, blockingcargo audit, the 3.9–3.13 test matrix, and the benchmark quality gate (8x floor).git commit -s).Docs-only: no source, tests, fixtures,
.github/,pyproject.toml, orCargo.tomltouched.Closes #51