Contributing

Contribution guidelines

This document sets out the methods and practices for contributing to the Faust project.

How to contribute

Please use the "Pull Request" mechanism for proposing contributions to the code base.

Brief overview of this process

Fork your own copy of Faust to your repository and create a dedicated branch from the faust:master-dev branch for your developments. Make your changes. You can commit to your branch as many times as you like. Validate your changes (see below).

Formatting the code

Be sure to use the make format command in the Faust root folder to properly format the new code.

Creating the pull request

When you're ready to provide your changes "upstream," you can open a pull request to the faust:master-dev branch. NB: You will want to make sure you're proposing a merge to master-dev.

Review and merge

We will then review your submission. If you are asked to make changes, you can push these changes to your original branch and the pull request will be automatically updated. Once the changes have gone through our review process, we will merge your changes into our repository. You may then delete your dedicated branch.