CONTRIBUTING.md

Contributing

Nendo is a collaborative effort and we greatly appreciate any and all contributions and will always give credit to the authors.

Development environment setup

It's super easy to get started with the nendo development environment. Just make sure you are using a supported version of python (3.8, 3.9 or 3.10) and run the following command from your nendo/ directory:

make setup

Note: Developing for and with Nendo Core requires careful dependency management. The use of a python virtual environment like pyenv or poetry is highly recommended.

Development process

To start writing code, proceed as follows:

1. create a new branch: git checkout -b feature/feature-name
   1. For branches introducing new features, please use the feauture/ prefix for your branch.
   2. For branches submitting buxfixes, please use the fix/ prefix for your branch.
2. edit the code and/or the documentation

Before submitting a PR for review:

1. run make format to auto-format the code
2. run make check to check everything (then fix any warning)
3. run make test to run the tests (then fix any issue)
4. if you updated the documentation or the project dependencies:
   1. run make docs
   2. go to http://localhost:8000 and check that everything looks good
5. Once everything is looking smooth, create your Pull Request on github

Using poetry

If you want to use poetry:

1. Install poetry
2. git clone [email protected]:okio-ai/nendo.git
3. cd nendo
4. make setup-poetry

Remember to also prepend poetry run to all make commands in order for them to work.