Contributing to HyperShift
Thanks for your interest in contributing to HyperShift. Here are some guidelines that help make the process more straightforward for everyone.
Prior to Submitting a Pull Request
- Prior to committing your code, run
make pre-commit. This updates all Golang and API dependencies, builds the source code, builds the e2e tests, verifies source code format, and runs all unit tests. This will help catch issues before committing so that the verify and unit test CI jobs will not fail on your PR.
- Before submitting your pull request on GitHub, look at your changes and try to view them from the eyes of a reviewer.
- Try to find the aspects that might not immediately make sense for someone else and explain them in the pull request description.
- Keep commits/changes scoped to one thing and as minimal as possible.
- Always keep refactorings (how we do something) separate from logic changes (what we do).
- If you find additional things along the way that you feel should be improved, do that in a separate pull request.
- This helps ensure that you will get a timely review of your change, as a series of small pull requests is a lot easier to review than one big pull request that changes 10 independent things for independent reasons.
- Use the imperative mood in the subject line for every commit, e.g.
Mark infraID as requiredinstead of
This patch marks infraID as required.
- This follows Git’s own built-in conventions; see github.com/openshift/hypershift/pull/485 as an example.
- Make sure the "Why" and "How" are included in the message of each commit.
Creating a Pull Request
- For small changes, you can just do the change and submit a pull request with it.
- For bigger changes (more than 200 lines of code diff), do not just do the change but, ask for feedback on the idea and direction of the change first (Either in a GitHub issue or the #project-hypershift channel in the External Red Hat Slack).
- This avoids situations where big changes are submitted that are then declined or never reviewed, which is frustrating for everyone.
- Regardless of the size of the change, always explain how the change will improve the project.
- Every PR title must be prefixed with the Jira ticket that is addressing e.g. https://github.com/openshift/hypershift/pull/2233.
- This repository is the base code for the Hypershift Operator and the Control Plane Operator (belongs to the OCP payload) so they might have different release cadence.