- Do your best to follow coding best practice. If writing in Go some good practices are documented here.
- When in doubt follow the coding style already present
- We are trying to improve our code documentation, add function comments where applicable or unclear
- Other contributors will review PRs, provide feedback, and then accept. We use a two reviewer system.
To make it easy to review and understand your changes, please keep the following things in mind before submitting your pull request:
- For the project, create a feature branch with your suggested changes, and PR your feature branch
- Use GoLang 1.15 or later
- Don't mix several features or bug fixes in one pull request.
- Make sure commits are split into logical units with good descriptions
- Create a meaningful commit message.
- Format your source with
go fmt.