📝 Contribute
Contributions to the Mercury environment are very much appreciated in whatever form they come! You can contribute in any of the following ways:
- Add suggestions, bugs or feature-requests to the:
- Look at any of the issues above and start working on something you think you can help with
- Make additions or changes to the Documentation, Tutorials, Examples and any other text in any of these repositories
- Adjust the source code or make bugfixes and add features by forking and sending a pull request (see the Guidelines)
You are also always welcome to reach out if you like to help but don't know where to start.
In order to make changes to various types of source code files you will need the following:
JavaScript code
- Requires a standard code-editor (like VSCode or Pulsar) to edit/modify/save the JS code.Patchers
- Requires a Max8 environment and license to edit/modify/save the patchers.GenExpr Code
- Requires a standard code-editor (like VSCode or Pulsar) to edit/modify/save the GenExpr code.
Guidelines
In order to receive your contribution please follow these steps:
- Fork this repository (click
fork
in the top right) - Clone the repository to your computer
git clone https://github.com/<this-is-you>/<forked-repo>.git
- Branch the Fork
git checkout -b <name-your-branch>
- Make any changes/additions to the code or docs
- Add, commit and push your changes
git add .
git commit -a
git push origin <your-branch-name>
- Go to your forked repo in the browser and click
compare & pull request
, thencreate pull request
- Please add a comment to clarify what you did and why