This guide is meant to facilitate Submariner code review by sharing norms, best practices, and useful patterns.
Submariner follows the Kubernetes Code Review Guide wherever relevant. This guide collects the most important highlights of the K8s process and adds Submariner-specific extensions.
Pull Requests to Submariner require two non-author code review approvals.
At least one approval must be from a Committer to the relevant part of the code base, as defined by the CODEOWNERS file at the root of the repository.
Kubernetes recommends avoiding merge commits.
git fetch and
git rebase to avoid them.
Kubernetes recommends squashing commits using these guidelines.
After a review, prepare your PR for merging by squashing your commits.
All commits left on your branch after a review should represent meaningful milestones or units of work. Use commits to add clarity to the development and review process.
Before merging a PR, squash the following kinds of commits:
Kubernetes recommends these commit message practices.