Contributing to InKCre
InKCre welcomes code, documentation, design, and ecosystem contributions. Start by identifying the owner of the change; then follow that owner's current development and review contract.
There is no copied, universal setup or contribution procedure. Toolchains and commands
belong to the repository that runs and verifies them.
Choose the change owner
| Change | Start here |
|---|---|
| Product purpose, behavior, or shared vocabulary | InKCre/docs → 10-prd/** |
| Cross-unit state, topology, or interoperability | InKCre/docs → 20-product-tdd/** |
| Hub/Spoke shared-document workflow | InKCre/docs → 00-meta/** |
| Core runtime, migrations, or database lifecycle | InKCre/core-py |
| Web client or browser extension | InKCre/client-web |
| Design tokens or shared UI | InKCre/ui |
| Public website content or presentation | InKCre/docs → website/** |
If a change spans repositories, separate the shared contract from each repository's implementation instead of making one repository silently own the others.
Follow the selected repository
After choosing an owner:
- Read its root
README.mdandAGENTS.md, plusCONTRIBUTING.mdwhen present. - Use the runtime and package manager pinned by that repository.
- Run its own formatter, checks, and tests.
- Follow its pull-request and review requirements.
Useful entry points:
Changes to shared truth
The docs repository is the Hub for durable product and cross-unit truth used across InKCre repositories. For a shared-truth change:
- Update and publish the canonical Hub owner.
- Update each consuming Spoke's shared reference.
- Apply Spoke-local implementation or documentation changes.
Keep those steps in separate commits so ownership and rollback remain visible. The Hub/Spoke operations contract contains the repository-specific workflow.
Website contributions
This website is a reader-oriented projection, not a second owner for product or cross-unit contracts. Public-only About facts belong here; product and architecture summaries must continue to agree with their Hub owners.
The website README owns its route, authoring, build, and publication contract.