From 8208aa5f64430a3e0b9617de1a1ceae4bcb3a734 Mon Sep 17 00:00:00 2001 From: Camila Macedo <7708031+camilamacedo86@users.noreply.github.com> Date: Tue, 16 Jan 2024 08:29:42 +0000 Subject: [PATCH] :book: Update CONTRIBUTING.md: Add info about 1 need/commit per PR --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f1c031764b4..46028d1a1b5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,6 +24,13 @@ Please see https://git.k8s.io/community/CLA.md for more info. 1. Fork the desired repo, develop and test your code changes. 1. Submit a pull request. +In addition to the above steps, we adhere to the following best practices to maintain consistency and efficiency in our project: + +- **Single Commit per PR:** Each Pull Request (PR) should contain only one commit. This approach simplifies tracking changes and makes the history more readable. +- **One Issue per PR:** Each PR should address a single specific issue or need. This helps in streamlining our workflow and makes it easier to identify and resolve problems such as revert the changes if required. + +For more detailed guidelines, refer to the [Kubernetes Contributor Guide][k8s-contrubutiong-guide]. + ## How to build kubebuilder locally Note that, by building the kubebuilder from the source code we are allowed to test the changes made locally. @@ -198,3 +205,4 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of [golangci]: https://github.com/golangci/golangci-lint [kind]: https://kind.sigs.k8s.io/#installation-and-usage [setup-envtest]: https://book.kubebuilder.io/reference/envtest +[k8s-contrubutiong-guide]: https://www.kubernetes.dev/docs/guide/contributing/