Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Keep in mind as you contribute, that code, docs and other material submitted to this projects are considered licensed under AGPL license.

Setup developement environment

We recommand to install rust with rustup. If you want perform a documentation contribution install mdbook.

Before start any modification please create a specific branch:

git switch -c fix_11         # branch create to fix issue 11
git switch -c feat_index_rc  # branch to add a new index reverse complement method

Before submit pull request make sure you run:

cargo fmt --all
cargo clippy --all-targets
cargo test --all-targets

You can check your new code are covered by run:

cargo tarpaulin

And open website/tarpaulin-report.html

After change you can run:

cargo doc

And open target/doc/kff/index.html to check effect of your change.

After change you can run:

cargo tarpaulin
cargo doc --target-dir website
mdbook serve

To check effect of your change.