Getting Started with Contributing
Contribute / Start Here
Contributor setup
Prepare a workstation, create a first branch, and run the initial local checks.
Verify
PR-equivalent local gate
make bootstrap
make doctor
make ci-core
Use this as the baseline local proof for a new branch or workstation setup.
Core path
- 01Open
Set up your environment
Install the required tools, use the repo-managed bootstrap flow, and verify that your local environment is actually healthy.
- 02Open
Learn the coding rules
Read the project conventions, code standards, and generated-artifact rules before reshaping code or manifests.
- 03Open
Understand the testing stack
Know which layers to run locally and what CI is going to enforce for the branch.
- 04Open
Open a clean branch
Use the commit and change-management rules the project expects once your local setup is stable.
Decision matrix
Contribution lanes
| Type | What it usually changes | Read this next |
|---|---|---|
| Code changes | Controller logic, APIs, adapters, reconciliation behavior, tests, or generated assets. | Open the coding standards and testing strategy. |
| Documentation changes | User guides, contributor docs, IA work, examples, or style fixes. | Open the documentation style guide and contributor standards. |
| Maintainer work | Release flow, CI changes, distribution policy, or supply-chain controls. | Open Validate & Ship and Project Governance. |
After setup
You are reading the unreleased main docs. Use the version menu for the newest published release, or check the release notes for what is already out.
Was this page helpful?
Use Needs work to open a structured GitHub issue for this page. The Yes button only acknowledges the signal locally.