Code Standards
Rust
- Format with
rustfmt(configured in.rustfmt.toml, edition 2021) - Run
cargo clippywith warnings denied before committing - All public APIs must have doc comments
cargo fmt --all -- --checkcargo clippy -p briefcase-core --locked -- -D warningsPython
- Follow PEP 8
- Use type annotations
- Format with
black, lint withflake8, and type-check withmypy
Install the tooling with the dev extra:
pip install briefcase-ai[dev]black briefcase/ tests/flake8 briefcase/ tests/mypy briefcase/Commit Messages
Use conventional commits:
feat: add drift detection threshold configfix: handle empty snapshots in replaydocs: update storage adapter examplesPull Request Process
- Branch from
main - Write tests for new functionality
- Ensure all tests pass
- Request review from a maintainer