# Contributing to criterion-polyglot

## Ideas, Experiences and Questions

Issues, ideas, requests and questions should be posted on the issue tracker at:

https://codeberg.org/overhacked/criterion-polyglot/issues

## A Note on Dependency Updates

criterion-polyglot does not accept pull requests to update dependencies unless specifically
requested by the maintaner(s). Dependencies are updated manually by the maintainer(s) before each
new release.

## Code

Pull requests are welcome, though please raise an issue for discussion first if none exists.

To make changes to the code, fork the repo and clone it:

`git clone git@codeberg.org:your-username/criterion-polyglot.git`

Then make your changes to the code. When you're done, run the tests:

```
cargo test --all
```

It's a good idea to run clippy and fix any warnings as well:

```
cargo clippy --all
```

Finally, run Rustfmt to maintain a common code style:

```
cargo fmt --all
```

Don't forget to update the CHANGELOG.md file and any appropriate documentation. Once you're finished, push to your fork and submit a pull request. I try to respond to new issues and pull requests quickly, so if there hasn't been any response for more than a few days feel free to ping @overhacked@recurse.social.

Some things that will increase the chance that your pull request is accepted:

* Write tests
* Clearly document public methods
* Write a good commit message

## Branches

*   PRs with breaking changes are made against the unreleased branch. e.g. branch version-0.2
*   PRs without breaking changes are made against the master branch.

If you're not sure which branch to use just start with master, as this can be changed during review.

When it is time to release the unreleased branch, a PR is made from the unreleased branch to master.

## Code of Conduct

We follow the [Rust Code of Conduct](http://www.rust-lang.org/conduct.html).