Contributing

Contributions are welcome and very much appreciated!

Code contributions

We accept code contributions through pull requests. In short, this is how that works.

Create a virtual environment using your tool of choice (e.g. virtualenv, conda, etc).

conda env update -f environment.yml
conda activate compas_mrr-dev
pip install -e .[dev]

virtualenv --python=python3.10 {{path/to/venv}}
source {{path/to/venv}}/bin/activate
pip install -e .[dev]

(Optional) Make package accessible in Rhino and Grasshopper
```
python -m compas_rhino.install
```

Make sure all tests pass on the unmodified code:
```
pytest
```
Start making your changes to the main branch (or branch off of it) on your fork.
Make sure all tests still pass:
```
pytest
```
Document the changes in the CHANGELOG.md
Commit your changes and push your branch to GitHub.
Create a pull request through the GitHub website.

When reporting a bug please include: