|
| 1 | +--- |
| 2 | +title: Opening Pull Requests |
| 3 | +weight: 30 |
| 4 | +--- |
| 5 | + |
| 6 | +Changes to Operator SDK are submitted via [Github Pull Request (PR)][gh-pr] |
| 7 | +to the relevant repository. Most PRs will be to the [main Operator SDK repo][operator-sdk-repo]. |
| 8 | + |
| 9 | +## PR Checklist |
| 10 | +1. Add [tests][adding-tests] for your change, and ensure they run and pass in CI. |
| 11 | +1. Add a [changelog entry][changelog-docs] if necessary. |
| 12 | +1. Add relevant [documentation][adding-docs]. |
| 13 | +1. Rebase your commits on master and squash them into a single commit. |
| 14 | +1. Write a concise commit message that references the issue number. |
| 15 | +1. Push your commit to your fork and [open a pull request][gh-fork-pr]. |
| 16 | + |
| 17 | + |
| 18 | +## Review |
| 19 | + |
| 20 | +Before a pull request can be merged, tests must pass in CI and it must be reviewed. A PR |
| 21 | +must be approved by 2 reviewers, one of which must be at least at least a reviewer and one |
| 22 | +of which must be at least an approver, per the [Operator Framework community guidelines][of-contributor-ladder]. |
| 23 | + |
| 24 | +Please feel free to message the developers to get eyes on your PR, whether through @'ing on the PR itself, |
| 25 | +the #operator-sdk-dev channel on Kubernetes slack, or by attending the Operator SDK [triage meeting][triage-meeting]. |
| 26 | + |
| 27 | +[adding-docs]:https://sdk.operatorframework.io/docs/contribution-guidelines/documentation/ |
| 28 | +[adding-tests]:https://sdk.operatorframework.io/docs/contribution-guidelines/testing/ |
| 29 | +[changelog-docs]:https://sdk.operatorframework.io/docs/contribution-guidelines/changelog/#m-docscontribution-guidelineschangelog |
| 30 | +[gh-fork-pr]:https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork |
| 31 | +[gh-pr]:https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests |
| 32 | +[of-contributor-ladder]:https://github.com/operator-framework/community/blob/master/contributor-ladder.md |
| 33 | +[operator-sdk-repo]:https://github.com/operator-framework/operator-sdk |
| 34 | +[triage-meeting]:https://github.com/operator-framework/community#operator-sdk-issue-triage |
0 commit comments