Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (50 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

68 lines (50 loc) · 1.82 KB
Raw

Contributing to Kiri

Thanks for taking the time to improve Kiri.

Kiri supports macOS arm64/x64, Linux x64, and Windows x64 with prebuilt release artifacts. Linux arm64 and Windows arm64 remain planned until collectors, artifacts, and npm packages are published for those targets.

Product boundaries

  • Product name: Kiri
  • Public command: ports
  • Cargo package: kiri
  • npm package: @gaossr/kiri
  • Homebrew formula: gaossr/tap/kiri
  • Current supported runtime platforms: macOS arm64/x64, Linux x64, Windows x64

Do not reintroduce legacy public command names. Keep user-facing install instructions focused on npm, Homebrew, and the GitHub Release install script.

Development setup

Install Rust using rustup, then run:

cargo fmt --check
cargo test
cargo clippy --all-targets -- -D warnings

Useful local commands:

cargo run --bin ports
cargo run --bin ports -- --all
cargo run --bin ports -- ps
cargo run --bin ports -- logs 3000 --lines 20

For npm packaging work:

npm --prefix packaging/npm run check
npm --prefix packaging/npm run test

For Homebrew formula work:

brew audit --formula gaossr/tap/kiri
brew test gaossr/tap/kiri

Pull request expectations

  • Keep changes focused on the reported behavior or documented feature.
  • Add or update tests for parser, formatter, renderer, release, or packaging behavior whenever the change can regress.
  • Preserve the public ports command and the documented platform support boundary.
  • Run the relevant verification commands before opening a pull request.
  • For release and packaging changes, include the exact install path or artifact that was verified.

Release notes

Release-facing changes should update CHANGELOG.md and keep README.md / README_CN.md aligned when install commands, support status, or package names change.