# Contribution guidelines
First off, thank you for considering contributing to `molio`.
If your contribution is not straightforward, please first discuss the change you
wish to make by creating a new issue before making the change.
One of the project goals is to be easy to understand so, especially for github
actions, try to keep things simple and to add comments whenever this is not
possible.
## Reporting issues
Issues have to be reported on our [issues tracker](https://github.com/chem-william/molio/issues). Please:
- Check that the issue has not already been reported.
- This can be achieved by searching keywords on the [issues tracker](https://github.com/chem-william/molio/issues).
- Try to use a clear title, and describe your problem with complete sentences.
## Pull requests
Try to do one pull request per change.
## Developing
### Set up
This is no different than other Rust projects.
```shell
git clone https://github.com/chem-william/molio
cd molio
cargo build
```
### Useful Commands
- Build and run release version:
```shell
cargo build --release && cargo run --release
```
- Run Clippy:
```shell
cargo clippy
```
- Run all tests:
```shell
cargo test --all
```
- Check to see if there are code formatting issues
```shell
cargo fmt --all -- --check
```
- Format the code in the project
```shell
cargo fmt --all
```