Contributing

This section is guidance for those who want to change Tazuna’s codebase, documentation, or releases. The repository root’s CONTRIBUTING.md is the primary source; this section supplements it with one page per topic.

Contents

• Development Environment — toolchain setup with mise, building a local binary with make build, and repository layout.
• Testing — the 3 layers of unit / integration / e2e and their make target correspondence, KinD cluster preparation.
• Documentation — the structure of docs/, previewing with mdbook, updating the English translation via po/en.po, and publishing to GitHub Pages.
• Release — releases via goreleaser triggered by tag push, version embedding, SBOM / signing / provenance.

Bug Reports / Feature Proposals

Use the Issue templates on GitHub. Free-form issues without a template are also accepted.

For security-related problems, follow the procedure in SECURITY.md. Do not create a public issue.

Pull Request Flow

Same as the description in CONTRIBUTING.md. Restated here.

1. Branch off main for your working branch.
2. Keep each change small and focused on one topic.
3. Before pushing, run make test and make lint locally and ensure they pass.
4. Open a PR against main. It does not enter review until CI is green.

Use the .github/PULL_REQUEST_TEMPLATE.md PR template in the repository.