When contributing to this repository, please adhere to the below guidelines.
- Create an issue
- Pre-push changes
- Commit message format
- Pull request process
- Before pushing code to the repo, it is required to create an issue along with a brief description so that other developers can comment, provide suggestions and feedback
Before pushing the code to repo please make sure to:
- Update the README.md with details of changes to the interface, this includes the new environment variables, exposed ports, useful file locations and container parameters
- Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we (would like to) use is SemVer
- Commit message should be of the following format
[ISSSUE_NO] COMMIT_MESSAGE
You can obtain ISSUE_NO from issue information
Please note that you cannot push directly to develop/master branch.
- Create a new branch and push the changes to this branch
- Create a PR and add at least one reviewer
- You may merge the Pull Request in once you have the sign-off of any other developer, or if you do not have permission to do that, you may request the reviewer to merge it for you