Skip to content

Latest commit

 

History

History
27 lines (16 loc) · 689 Bytes

CONTRIBUTING.md

File metadata and controls

27 lines (16 loc) · 689 Bytes
Raw

Contributing to modalkit

Building

You can build modalkit locally by using cargo build.

Pull Requests

When making changes to modalkit, please make sure to:

  • Add new tests for fixed bugs or new features
  • Add new documentation with new features

If you're adding a large amount of new code, please make sure to look at a test coverage report and ensure that your tests sufficiently cover your changes.

You can generate an HTML report with cargo-tarpaulin by running:

% cargo tarpaulin --avoid-cfg-tarpaulin --out html

Tests

You can run the unit tests and documentation tests using cargo test.