Contributions are welcome via GitHub Pull Requests ("PR"). This document outlines the process to help get your contribution accepted.
Any kind of contribution is welcome, from new features to bug fixes to documentation improvements. However, Engity will review the proposals and perform a triage over them. By doing so, we will ensure that the most valuable contributions for the community will be implemented in due time.
- Fork this repository, develop, and test your changes.
- Submit a pull request.
- Read and agree to our Contributor License Agreement as requested in the pull request.
When submitting a PR make sure that it:
- Must pass CI jobs/actions.
- Must follow Golang best practices.
- Is signed off with the line
Signed-off-by: <Your-Name> <Your-email>. Learn more about signing off on commits.[!Note] Signing off on a commit is different from signing a commit, such as with a GPG key.
- Changes are manually reviewed by Engity's Bifröst team members.
- When the PR passes all tests, the PR is merged by the reviewer(s) in the GitHub
mainbranch.
There are no fixed cycles for releases. Currently, they are triggered as soon bugfixes, security updates, or main features arrive.
First of all, prepare the release notes as usual, and merge them.
Once the release notes are ready, a release train is launched by tagging from main to vX.Y.Z.
The vX.Y.Z tag will go through the release CI.
If anything fails the release tag is dropped, the issue fixed in main and a new release train is started on a new tag.