Why
CONTRIBUTING.md is both incomplete (it omits requirements we actually
enforce) and stale (it references tooling/paths we no longer use). PR #1887
is a good example: the contributor followed the public guide, but tripped over
process rules that are only written down in AI_POLICY.md / .ai /
.audit/AI_AUDIT_PROCESS.md, not in CONTRIBUTING.md. Let's make the public
guide match reality so external contributors can succeed first time.
Missing — add these
Stale — fix these
Notes
- Pure documentation; no code/behaviour change.
- Keep
CONTRIBUTING.md aligned with docs/contributing.rst if both are shipped.
This analysis was produced with AI assistance (Claude Code) and requires human review before filing. Which I did.
Checklist
Why
CONTRIBUTING.mdis both incomplete (it omits requirements we actuallyenforce) and stale (it references tooling/paths we no longer use). PR #1887
is a good example: the contributor followed the public guide, but tripped over
process rules that are only written down in
AI_POLICY.md/.ai/.audit/AI_AUDIT_PROCESS.md, not inCONTRIBUTING.md. Let's make the publicguide match reality so external contributors can succeed first time.
Missing — add these
issue, and the PR must reference it (
Closes #<issue>). The current"Contributing Code" list jumps straight to fork/branch.
disclosure file at
.audit/<github-username>_<branch>.md(e.g..audit/bblommers_websocket-server-typing.md), not a PR comment. Link.audit/AI_AUDIT_PROCESS.mdand
AI_POLICY.md. (This is the biggest gap — currently undocumented.)fix_<issue>convention for maintainers,while making clear descriptive branch names from external forks are welcome
(e.g.
patch-1).Stale — fix these
tox/tox -e py312section with thecurrent
justrecipes (just test,just check, etc.).pytest autobahn/test/test_websocket.py→ src-layoutsrc/autobahn/test/....pip install -e .[dev,twisted,asyncio]andcd docs && make htmlagainst the current extras ([all]/[dev]) and thejust docsrecipe.Notes
CONTRIBUTING.mdaligned withdocs/contributing.rstif both are shipped.This analysis was produced with AI assistance (Claude Code) and requires human review before filing. Which I did.
Checklist