Contributing Guidelines

Contributions are welcome via GitHub Pull Requests ("PR"). This document outlines the process to help you get your contribution accepted.

Any kind of contribution is welcome, from adding new features or bug fixes to improving the documentation. 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.

How to Contribute

1. Fork this repository, develop, and test your changes.
2. Submit a pull request.
3. Read and agree to our Contributor License Agreement as requested in the pull request.

Technical Requirements

When submitting a Pull Request ("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 a commit is different from signing a commit, such as with a GPG key.

PR Approval

1. Changes are manually reviewed by Engity's Bifröst team members.
2. When the PR passes all tests, the PR is merged by the reviewer(s) in the GitHub main branch.

Release process

Schedule

There are no fixed cycles for releases. Currently, they are triggered as soon as bugfixes, security updates or main features arrive.

Creation

Prepare release notes for the GitHub Release description separately from operator-facing upgrade instructions in docs/setup/upgrade.md. For a new minor release, replace that upgrade page with guidance from the preceding minor series, or state explicitly that no action is necessary. Patch releases normally retain their minor series' upgrade instructions. Merge changes to the versioned documentation before tagging, and link the published upgrade page from the GitHub Release description.

Once the release notes are ready, a release train is launched by tagging from main to vX.Y.Z.

Validation

The vX.Y.Z tag will go through the release CI.