# Contributing to GIRAFFE

We want to make contributing to this project as easy and transparent as possible.

## Pull requests

We actively welcome your pull requests.

If you're new to pull requests on github, we encourage you to take a look at the following [information](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).

## For enhancements or bug fixes

1. Fork the repo and create your branch from `main`.
2. Make sure you have a GPU-enabled machine, either locally or in the cloud.
3. Create the corresponding Anaconda environment with `conda env create -f environment.yml`.
4. Make your code changes.
5. Create a pull request.
6. Address any feedback in code review promptly.

## For any issue

We use GitHub issues to track ideas and bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

## License

By contributing to examples, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.