Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (24 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.17 KB
Raw

Contributing

Kora is developed in public and we appreciate contributions.

Important: Branch Targeting

The main branch is the integration branch. All feature work and bug fixes should target main.

Audit status is commit-based, not branch-based. Audited baselines are tracked in audits/AUDIT_STATUS.md, and stable releases are represented by immutable tags/releases.

Do not use long-lived release branches. Use tags/releases plus audits/AUDIT_STATUS.md to communicate audited baselines.

Security

For security vulnerabilities related to code on main, please review SECURITY.md before opening a public issue.

Getting Started

  1. Install Rust and Cargo
  2. Build all packages: make build
  3. Run formatting and lint checks: make check
  4. Run unit tests: make unit-test
  5. Run integration tests: make integration-test

TypeScript SDK

make install-ts-sdk
make build-ts-sdk
make unit-test-ts

Before Submitting

  • Run make check (formatting + clippy)
  • Run make unit-test
  • Use conventional commits (feat:, fix:, chore:, etc.)