When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please follow Code of Conduct in all your interactions with the project.
We use go-report to evaluate our code. So please check your code score before creating pull request.
Contributor Workflow
To contribute, the workflow is as follows:
- Fork repository
- Create topic branch
- Commit your change
- Push changes to your fork
- Create pull request
Pull Request Process
- Ensure your fork is upto date.
- Update README.md with details of changes to interface, this includes new environment variables, exposed ports, useful file locations,etc.
- Your pull request will be merged once one of the reviewer reviews the changes.
Some tips for commits
- Write quality commit messages.
- Do not add too many redundant commits. If so, squash your commits using:
git checkout your-branch
git rebase -i HEAD~n
# n is the number of commits in pull request
git push #push to github