Contributing

This repository uses repo-local documentation, scripts, and tests as the source of truth for active behavior and validation.

License and Contribution Terms

By submitting a contribution, you agree that your contribution is licensed under the project Apache License 2.0.

Before You Start

Read README.md.
Read the relevant docs under docs/.
Inspect the code and tests for the area you will change.
Decide the smallest safe change that satisfies the request.

Maintainers and automation authors should also read docs/automation.md for repo-local release and agent workflow notes that are intentionally kept out of the repository root.

Working Rules

Keep changes minimal and atomic.
Update tests together with implementation changes.
Prefer main-thread integration for shared or high-conflict files.
Do not let multiple agents edit the same code region at the same time.

Local Checks

Run the verification commands that match the surface you changed before you hand work back.

Common repository checks already used here include:

./scripts/dev/ci-local.sh
./scripts/policy/check-open-source-assets.sh
go test ./...
make test
make lint
bash test/scripts/run_all_tests.sh --jobs 8
./scripts/policy/check-generated-drift.sh
./scripts/policy/check-command-surface.sh --strict
./scripts/release/verify-package-managers.sh
git diff --check

Pull Request Checklist

Keep implementation and tests in sync.
Run ./scripts/dev/ci-local.sh.
Run ./scripts/policy/check-command-surface.sh --strict when command paths/flags change.
Run ./scripts/policy/check-generated-drift.sh when generated artifacts may change.
Run ./scripts/release/verify-package-managers.sh when packaging or installer surfaces change (run make package first).
Update docs and CHANGELOG.md for behavior/interface changes.
Include verification evidence in your PR description.

Submission Flow

Make the smallest atomic change that satisfies the task.
Keep doc edits factual and limited to implemented behavior.
Run the relevant verification commands.
Report the validation results with the handoff.

2.1 KiB Raw Blame History