Thank you for your interest in contributing to Hyperion. When contributing to Hyperion you will first want to make an issue so that we can discuss the change. Please follow our code of conduct when interacting with this project. If you find an existing issue that you want to fix, then claim it by assigning it to yourself. Once an issue has been discussed/approved:
- Fork Hyperion.
- Clone your fork of Hyperion.
- Make changes and commit them.
- Push these changes up to your fork.
- Submit a pull request from your fork with the "base" being
willowtreeapps:developand then the "compare" being your branch.
Please follow this guide for more instruction on forking.
It is crucial that any change made to HyperionCore does not break backwards compatibility with older plugins. This is why it is important to communicate any changes to HyperionCore with the owners via issue.
Most Hyperion plugins should go in their own repo. If you feel that there is a plugin that would be of use to the entire user base, please submit an issue and we will discuss whether it should go into the main repo. If your plugin is not a fit for the main repo, then you can still link to it in our ReadMe.md under the Third-Party Plugins section. Just submit a pull request with the change to the ReadMe and make the base master.
By submitting a pull request, you represent that you have the right to license your contribution to WillowTree and the community, and agree by submitting the patch that your contributions are licensed under the MIT License.