Skip to content

docs: align contributor paths with current runtime #796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rajnisht7 merged 2 commits into from
Oct 29, 2026
Merged

docs: align contributor paths with current runtime #796

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2fb237
docs: align contributor paths with current runtime
dinakarjs Oct 21, 2026
203f5d0
chore: synchronize contributor docs with current main
dinakarjs Oct 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ pip install -e ".[dev]"

```bash
ruff check src/ tests/ # lint
mypy src/cmcp_gateway/ # type check
mypy src/cmcp_runtime/ # type check
bandit -r src/ -c pyproject.toml # security scan
pytest tests/unit/ -v # unit tests
```
Expand Down Expand Up @@ -99,9 +99,9 @@ Keep commits small and focused. One logical change per commit. Do not bundle unr

Changes to these paths require two maintainer approvals and a comment explaining the security impact:

- `src/cmcp_gateway/audit/`: signing, audit chain, TRACE Claim generation
- `src/cmcp_gateway/tee/`: TEE provider integration
- `src/cmcp_gateway/policy/`: Cedar policy evaluation
- `src/cmcp_runtime/audit/`: signing, audit chain, TRACE Claim generation
- `src/cmcp_runtime/tee/`: TEE provider integration
- `src/cmcp_runtime/policy/`: Cedar policy evaluation

## Reporting security vulnerabilities

Expand All @@ -111,7 +111,7 @@ Do **not** open a public issue. Use [GitHub Security Advisories](https://github.

- Python 3.11+ syntax throughout (`X | Y`, `match`, etc.)
- `ruff` enforces style; do not add `# noqa` without a comment explaining why
- `mypy --strict` on `src/cmcp_gateway/`; new public functions need type annotations
- `mypy --strict` on `src/cmcp_runtime/`; new public functions need type annotations
- No comments that describe *what* the code does: only *why* when non-obvious
- Tests live in `tests/unit/` and follow the existing `test_<module>.py` naming

Expand Down
Loading