Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Contributing

Aves is a small, opinionated project — contributions are welcome, but please open an issue before starting any non-trivial work so we can agree on shape.

Filing issues

The issue tracker lives at https://git.paximi.com/samuel/aves/issues. Bug reports should include:

  • The output of aves --version.
  • The host platform (Linux distribution + kernel version, or macOS version).
  • The relevant aves.toml, aves_manifest.toml, and (if applicable) the failing package.toml.
  • The full error output, with RUST_BACKTRACE=1 set if the CLI panicked.

Submitting a patch

  1. Open an issue describing the change.
  2. Fork and branch from main.
  3. Run cargo fmt and cargo clippy --all-targets -- -D warnings before pushing.
  4. Send a pull request that references the issue.

Adding a package

New packages live under packages/<name>/package.toml. See the package reference for the schema, and the existing nrf52-adafruit-uf2-bootloader package for a working example.

Adding a board

New boards live under boards/<name>.toml. See boards for the schema. Project-local boards should be added to the project itself; shared boards belong in the global registry and are reviewed before merging.