Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (34 loc) · 1017 Bytes

CONTRIBUTING.md

File metadata and controls

51 lines (34 loc) · 1017 Bytes

Contributing to Tonic

Setup

After cloning the repository, configure git to use the project's commit hooks:

git config core.hooksPath .githooks

This enables:

  • pre-commit: Runs cargo fmt (auto-fixes) and cargo clippy -- -D warnings on staged .rs files
  • pre-push: Runs cargo fmt --check, cargo clippy -- -D warnings, and cargo test

All clippy warnings are treated as errors. Commits with warnings will be rejected.

To bypass hooks in exceptional cases (CI tooling, etc.):

SKIP_GIT_HOOKS=1 git commit ...

Development

Build and test

cargo build
cargo test
cargo clippy --all-targets --all-features -- -D warnings

Commit messages

Use Conventional Commits:

feat: add bitstring pattern matching
fix: resolve REPL continuation for do/end blocks
refactor: split parser into modules

Branch naming

feature/descriptive-name
fix/issue-description

Never commit directly to main.