- Contributor: Issues have to be created using the supplied GitHub template. They should include a problem description as well as possible solutions. The better the problem and solution are described, the easier for the Curators and Others to understand it and the faster the process. In case of a bug, steps to reproduce will help a lot.
- Curators and Others: The curators will engage in a discussion about the problem and the possible solution. Others can join the discussion to bring other solutions and insights at any point.
- Curators: After the discussion mentioned above, it will be determined if the proposed solution will be implemented or not. Appropriate tags will be applied to the issue.
- Contributor: The contributor will work as follows:
- assign the issue to himself
- create a fork
- git clone the fork on your machine
- enable signing your work
- create a PR. use WIP to mark unfinished work e.g. WIP: Fixing a bug (fixes #1)
- after development has finished remove the WIP if applied
- Curators: The curators will conduct a full code review
- Curators: After at least 2 curators have approved the PR, it will be merged to master
- Curators: A release will follow after that at some point
PR's should have the following requirements:
- Tests are required (where applicable, terms may vary)
- Unit
- Component
- Integration
- High code coverage
- Coding style (go fmt)
- Linting we use golangci-lint
The Make file contains the appropriate command in order to verify all the above.