Contributing
Prerequisites
- Rust 1.94+ stable (
rustup toolchain install 1.94) cargo-deny(cargo install cargo-deny)
Setup
git clone https://github.com/greysquirr3l/redshank.git
cd redshank
cargo build --workspace
Workflow
- Create a branch:
git checkout -b feat/my-feature - Write a failing test first (TDD strategy)
- Implement until the test passes
- Run the full suite:
cargo test --workspace - Check lint:
cargo clippy --workspace -- -D warnings - Check deps:
cargo deny check - Commit with a conventional commit message
- Open a pull request
Commit conventions
| Prefix | Use for |
|---|---|
feat: | New features |
fix: | Bug fixes |
refactor: | Refactors without behaviour change |
test: | Test additions or fixes |
docs: | Documentation only |
Focus commit messages on user impact, not file counts or line changes.