Skip to content

Latest commit

 

History

History
22 lines (16 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

22 lines (16 loc) · 1.38 KB

Contributing

Thanks for contributing to this repository!

This repository follows the following conventions:

Development requires the Kubernetes CLI tool as well as a Kubernetes cluster. k3d is recommended as a lightweight local option for standing up Kubernetes clusters.

To contribute a change:

  1. Create a branch on the cloned repository
  2. Make the changes in code.
  3. Test by deploying Big Bang to your Kubernetes cluster and verifying overrides.
  4. Make commits using the Conventional Commits format. This helps with automation for changelog. Update CHANGELOG.md in the same commit using the Keep a Changelog. Depending on tooling maturity, this step may be automated.
  5. Ensure all new commits from the main branch are rebased into your branch.
  6. Open a merge request. If this merge request is solving a preexisting issue, add the issue reference into the description of the MR.
  7. Wait for a maintainer of the repository (see CODEOWNERS) to approve.
  8. If you have permissions to merge, you are responsible for merging. Otherwise, a CODEOWNER will merge the commit.