Skip to content

Commit 0fef5ed

Browse files
authored
Update CONTRIBUTING.md
Signed-off-by: Sukriti Sharma <Ssukriti@users.noreply.github.com>
1 parent 66acb4f commit 0fef5ed

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,10 @@ To contribute to this repo, you'll use the Fork and Pull model common in many op
3030
Guide](https://github.com/kubernetes/community/blob/master/contributors/guide/github-workflow.md)
3131
from Kubernetes.
3232

33-
When your contribution is ready, you can create a pull request. Pull requests are often referred to as "PR". In general, we follow the standard [GitHub pull request](https://help.github.com/en/articles/about-pull-requests) process. Follow the template to provide details about your pull request to the maintainers. It's best to break your contribution into smaller PRs with incremental changes, and include a good description of the changes.
34-
We require new unit tests to be contributed with any new functionality added.
33+
When your contribution is ready, you can create a pull request. Pull requests are often referred to as "PR". In general, we follow the standard [GitHub pull request](https://help.github.com/en/articles/about-pull-requests) process. Follow the template to provide details about your pull request to the maintainers.
34+
1. It's best to break your contribution into smaller PRs with incremental changes, and include a good description of the changes.
35+
2. We require new unit tests to be contributed with any new functionality added.
36+
3. For any new feature or capability, documentation is a MUST. Features will not be announced in releases without documentation on how to use them. This is common practice in any open-sourced repository.
3537

3638
Before sending pull requests, make sure your changes pass formatting, linting and unit tests. These checks will run with the pull request builds. Alternatively, you can run the checks manually on your local machine [as specified below](#development).
3739

@@ -50,6 +52,7 @@ Once you've [created a pull request](#how-can-i-contribute), maintainers will re
5052
- Follow the project coding conventions
5153
- Write detailed commit messages
5254
- Break large changes into a logical series of smaller patches, which are easy to understand individually and combine to solve a broader issue
55+
- Ensure documentation is added on "how to use" for any new capabilities. Ensure follow-up issues are created for documentation and that feature is documented before announcing release.
5356

5457
Maintainers will perform "squash and merge" actions on PRs in this repo, so it doesn't matter how many commits your PR has, as they will end up being a single commit after merging.
5558

0 commit comments

Comments
 (0)