📝 Contribute

Contributions to the Mercury environment are very much appreciated in whatever form they come, as long as they are made by humans! You can contribute in any of the following ways:

• Add suggestions, bugs or feature-requests to on of the issues pages:
  • Mercury4Max issues
  • mercury-playground issues
  • mercury-engine issues
  • mercury-lang issues
  • mercury-docs issues
• 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. I'm happy to discuss future plans for Mercury.

In order to make changes to various types of source code files you may need the following:

• JavaScript code - Requires a standard code-editor (like VSCodium or Pulsar) to edit/modify/save the JS code.
• Patchers - Requires a Max8/9 environment and license to edit/modify/save the patchers.
• GenExpr Code - Requires a standard code-editor (like VSCodium or Pulsar) to edit/modify/save the GenExpr code.

Usage of AI tools

• We value human thoughts and ideas over AI generated thoughts and ideas
• Be aware that the AI will trick you into thinking you came up with something, but actually you didn't. Don't post AI output as if it is your own.
• Don't submit any AI generated low-effort contributions.
• Don't use autonomous bots to scrape any of the code, documentation, tutorials, community interaction or other Mercury related webcontent.
• Don't paste other user's content or code into chatbot prompts without their consent.
• Some AI tools, such as (simple) translators, may be used to help one participate and contribute to the community, to remove a language barrier.

Inspired by the SuperCollider AI Tools Guidelines

Contribution Guide

In order to receive your contribution please follow these steps:

1. Fork this repository (click fork in the top right)
2. Clone the repository to your computer git clone https://github.com/<this-is-you>/<forked-repo>.git
3. Branch the Fork git checkout -b <name-your-branch>
4. Make any changes/additions to the code or docs
5. Add, commit and push your changes git add . git commit -a git push origin <your-branch-name>
6. Go to your forked repo in the browser and click compare & pull request, then create pull request
7. Please add a comment to clarify what you did and why

All steps with examples and images