Contributing

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

You can contribute in many ways:

Types of Contributions

Report bugs at issues.

If you are reporting a bug, please include:

The best way to send feedback is to file an issue at issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Ready to contribute? Here's how to set up RobustPalmRoi for local development.

Clone your fork locally:

git clone git@github.com:your_name_here/RobustPalmRoi.git

Create a branch for local development:
```
git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you're done making changes, check that your changes pass the tests and lints:
```
./manage.sh test_and_lint
```
and then it will pull docker image, and run tests and lints in container.

Commit your changes and push your branch to GitHub:

git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests and reach the codecov requirement(see in .codecov.yml).
Please follow Clean Code standards, and it would be nicer to follow the Google C++ Code Style.