Skip to main content

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

bash

make bootstrap
make doctor
make ci-core

Use this as the baseline local proof for a new branch or workstation setup.

Core path

  1. 01

    Set up your environment

    Install the required tools, use the repo-managed bootstrap flow, and verify that your local environment is actually healthy.

    Open
  2. 02

    Learn the coding rules

    Read the project conventions, code standards, and generated-artifact rules before reshaping code or manifests.

    Open
  3. 03

    Understand the testing stack

    Know which layers to run locally and what CI is going to enforce for the branch.

    Open
  4. 04

    Open a clean branch

    Use the commit and change-management rules the project expects once your local setup is stable.

    Open

Decision matrix

Contribution lanes

Contribution lanes.
TypeWhat it usually changesRead this next
Documentation changesUser guides, contributor docs, IA work, examples, or style fixes.Open the documentation style guide and contributor standards.
Maintainer workRelease flow, CI changes, distribution policy, or supply-chain controls.Open Validate & Ship and Project Governance.

After setup

Next release documentation

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.