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 failingpackage.toml. - The full error output, with
RUST_BACKTRACE=1set if the CLI panicked.
Submitting a patch
- Open an issue describing the change.
- Fork and branch from
main. - Run
cargo fmtandcargo clippy --all-targets -- -D warningsbefore pushing. - 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.