CONTRIBUTING.md

Contributing Guidelines

This document describes how to contribute to the project.

Prerequisites

• Go version 1.22+
• A valid OpenShift Cluster Manager (OCM) token and logged in via ocm-cli or rosa
• Access to ocm-backplane

Contributing steps

1. Submit an issue describing your proposed change
2. Fork the desired repo, develop and test your code changes
3. Submit a pull request

What to do before submitting a pull request

1. Ensure any additional AWS permissions are available in the STS Support Policy

2. Ensure the project builds and all tests pass

   go test -v ./...

3. Test the change against a staging ROSA cluster

   ocm-backplane tunnel -D
   mirrosa -cluster-id "${CLUSTER_ID}"

New Releases

New releases are currently manually triggered via .github/workflows/release.yml and produce binaries and cosign to sign them.