# Contribution guidelines
First off, thank you for considering contributing to perfume.
If your contribution is not straightforward, please first discuss the change you
wish to make by creating a new issue before making the change.
## Reporting issues
Before reporting an issue on the
[issue tracker](https://github.com/guapodero/perfume/issues),
please check that it has not already been reported by searching for some related
keywords.
## Pull requests
Try to do one pull request per change.
### Updating the changelog
Update the changes you have made in
[CHANGELOG](https://github.com/guapodero/perfume/blob/main/CHANGELOG.md)
file under the **Unreleased** section.
Add the changes of your pull request to one of the following subsections,
depending on the types of changes defined by
[Keep a changelog](https://keepachangelog.com/en/1.0.0/):
- `Added` for new features.
- `Changed` for changes in existing functionality.
- `Deprecated` for soon-to-be removed features.
- `Removed` for now removed features.
- `Fixed` for any bug fixes.
- `Security` in case of vulnerabilities.
If the required subsection does not exist yet under **Unreleased**, create it!
## Developing
### Set up
This is no different than other Rust projects.
```shell
git clone https://github.com/guapodero/perfume
cd perfume
cargo test
```
### Useful Commands
Be aware that there is an optional `nightly` feature which requires
[nightly rust](https://ehuss.github.io/rustup/concepts/channels.html#working-with-nightly-rust).
Some of the tests depend on generated code, which is why there is a `main.rs`.
- Run Clippy:
```shell
./task.zsh clippy
```
- Run all tests:
```shell
./task.zsh test
```
- Check to see if there are code formatting issues
```shell
cargo fmt --all -- --check
```
- Format the code in the project
```shell
cargo fmt --all
```
- Generate documentation (requires nightly channel)
```shell
RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --no-deps --all-features
```