Skip to content
Docs for briefcase-ai v3.3.0see what’s new.

Code Standards

Rust

  • Format with rustfmt (configured in .rustfmt.toml, edition 2021)
  • Run cargo clippy with warnings denied before committing
  • All public APIs must have doc comments
Terminal window
cargo fmt --all -- --check
cargo clippy -p briefcase-core --locked -- -D warnings

Python

  • Follow PEP 8
  • Use type annotations
  • Format with black, lint with flake8, and type-check with mypy

Install the tooling with the dev extra:

Terminal window
pip install briefcase-ai[dev]
Terminal window
black briefcase/ tests/
flake8 briefcase/ tests/
mypy briefcase/

Commit Messages

Use conventional commits:

feat: add drift detection threshold config
fix: handle empty snapshots in replay
docs: update storage adapter examples

Pull Request Process

  1. Branch from main
  2. Write tests for new functionality
  3. Ensure all tests pass
  4. Request review from a maintainer