| title | Developer Documentation |
|---|---|
| audience | developers, maintainers, contributors |
| prerequisites | repository checkout |
| related | architecture.md, packages/index.md, workflows/contributing.md |
| status | maintained |
| publication | reviewed |
PRIK turns source or semantic .pyi contracts into importable CPython
extensions through a staged build pipeline. These documents explain that
architecture, the components that implement it, and how to locate change and
test ownership.
When you are new to PRIK, read these pages in order:
- PRIK Architecture — build flow, stage handoffs, and the boundary at which each decision becomes fixed.
- Architecture Components — each build stage and supporting component: local modules, entrypoints, examples, and focused tests.
Install an editable checkout with development tools:
python3 -m pip install -e ".[qa]"For the short public checklist (branch, tests, changelog, license), see the
repository-root CONTRIBUTING.md. The full contributor path is in
Contributing workflow.
| Need | Doc |
|---|---|
| Locate packages, modules, and hotspots | Codebase Map |
| Connect a capability to code and evidence | Feature-to-Code Map |
| Choose where tests live and what they prove | Testing Strategy |
| Contribute, verify locally, and open a PR | Contributing workflow |
| Static analysis and broader verification | Quality Assurance |
| Hosted PR checks | Pull request checks |
| Maintain docs and executable examples | Documentation maintenance |