CONTRIBUTING.md

Contributing to ahocorasick_rs

Thank you for considering contributing! Note that by contributing your code, you are agreeing to license it under the Apache License 2.0 (see LICENSE).

Setting up a development environment

First, download and install Just

Then, setup a virtualenv, install dev dependencies, and compile the code:

just setup
source venv/bin/activateo  # or Windoes equivalent
just build-dev

Running tests and benchmarks

To run tests:

$ just test

To run benchmarks:

$ just prep-benchmark  # on Linux Intel, disables turbobost
$ just benchmark

Doing a release

1. Update version in Cargo.toml
2. Submit a PR
3. Merge to main
4. Tag in GitHub with new version number
5. Download Wheels.zip artifact from GitHub Actions
6. Upload by running maturin upload unzipped-files/*.whl