Contributing Guidelines

Before contributing to this repository, please discuss any proposed changes with the owners through an email.

Please remember to read our code of conduct.

Instructions

1. Fork the project on GitHub to create your own personal copy.
2. Clone your fork to your local machine, with your GitHub repository referred to as origin.
3. Add the original repository as a remote named upstream. If your fork was created some time ago, make sure to pull in changes from upstream into your local repository.
4. Create a new branch for your work, branching from develop if it exists, or from master otherwise.
5. If you are contributing to the rules or applications:
   1. Ensure that you have followed the common coding guidelines of the language (Go/Python) you have written the rule/application in.
   2. Do not forget to remove any hard-coded inputs, especially the credentials.
   3. Ensure that your rule executed without any errors.
6. If you are contributing to the platform code (src folder):
   1. Ensure that you have followed the common coding guidelines of Go.
   2. Ensure that there are no compilation/runtime errors or functional bugs.
7. Combine your commits into a single commit. Ensure your commit message clearly describes the changes made to the code, rather than detailing the actions you performed.
8. Push your branch to your fork on GitHub, using the remote named origin.
9. Then, open a pull request from your fork, targeting the project's develop branch if available; otherwise, select master.
10. After your pull request is approved and merged, you can pull the changes from upstream into your local repository and delete any extra branches you created.