Skip to content

Commit c856aee

Browse files
authored
Merge pull request #3732 from kubernetes-sigs/contributing-docs
📖 Update CONTRIBUTING.md: Add info about 1 need/commit per PR
2 parents 713c2d0 + 8208aa5 commit c856aee

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@ Please see https://git.k8s.io/community/CLA.md for more info.
2424
1. Fork the desired repo, develop and test your code changes.
2525
1. Submit a pull request.
2626

27+
In addition to the above steps, we adhere to the following best practices to maintain consistency and efficiency in our project:
28+
29+
- **Single Commit per PR:** Each Pull Request (PR) should contain only one commit. This approach simplifies tracking changes and makes the history more readable.
30+
- **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.
31+
32+
For more detailed guidelines, refer to the [Kubernetes Contributor Guide][k8s-contrubutiong-guide].
33+
2734
## How to build kubebuilder locally
2835

2936
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
198205
[golangci]: https://github.com/golangci/golangci-lint
199206
[kind]: https://kind.sigs.k8s.io/#installation-and-usage
200207
[setup-envtest]: https://book.kubebuilder.io/reference/envtest
208+
[k8s-contrubutiong-guide]: https://www.kubernetes.dev/docs/guide/contributing/

0 commit comments

Comments
 (0)