Thank you for your interest in contributing to the project! We are incredibly excited to see how members of our community will use and extend the platform plugin. To facilitate your contributions, we've outlined a brief set of guidelines to ensure that your extensions can be easily integrated.
First, please read through our code of conduct, as we expect all our contributors to follow it.
Second, before starting on modifications to the codebase, we strongly recommend posting on our Issues page and briefly outlining the changes you plan to make. This will enable us to provide some context that may be helpful for you. This could range from advice and feedback on how to optimally perform your changes or reasons for not doing it.
Lastly, if you're looking for input on what to contribute, feel free to
browse the GitHub issues with the Requests or Bug label.
The master branch corresponds to the most recent version of the project.
When contributing to the project, please make sure that your Pull Request (PR) contains the following:
- Detailed description of the changes performed
- Corresponding changes to documentation, unit tests and sample environments (if applicable)
- Summary of the tests performed to validate your changes
- Issue numbers that the PR resolves (if any)
When you open a pull request, you will be asked to acknolwedge our Contributor License Agreement. We allow both individual contributions and contributions made on behalf of companies. We use an open source tool called CLA assistant. If you have any questions on our CLA, please submit an issue.