Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 951 Bytes

CONTRIBUTOR.md

File metadata and controls

41 lines (30 loc) · 951 Bytes

Contributing

Contributions are more than welcome! The library is still in its early development phase. There is not even a definite road map at this point. Please utilise the Issues feature on GitHub or open a PR from your own fork to start a discussion ☺️..

🪝 Hooks 🪝

We recommend using the hooks while developing in this repository. The hooks manager is a python package which needs installing locally. The best way to do this is via a virtual environment.

> python3 -m venv .venv
> source .venv/bin/activate
> pip install -r requirements.txt
> ./configure-hooks.sh install

🧱 Building 🧱

To build, simply follow the usual cargo flow.

> cargo build --all-features

Tests

The project currently has a good unit tests coverage, but no integration test coverage yet. To run the tests, follow the usual cargo flow.

> cargo test --all-features

🌍 A Tour of midi2 🌍

todo