Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
27 lines (17 loc) · 661 Bytes

CONTRIBUTING.md

File metadata and controls

27 lines (17 loc) · 661 Bytes
Raw

Contributing

Thanks for your interest in lowfat.

Build & test

cargo build
cargo test --workspace

The workspace has four crates: lowfat-core, lowfat-plugin, lowfat-runner, and the lowfat CLI.

Pull requests

  • Keep PRs small and focused on one change.
  • Add a test for new behaviour; unit tests live alongside the code.

Writing a plugin

See docs/PLUGINS.md. Bundled plugins live under crates/lowfat-plugin/embedded/ (they ship in the binary); community plugins live under plugins/.

Releases (maintainers)

Bump version in Cargo.toml, tag vX.Y.Z, push — the release workflow handles the rest.