Skip to content

Commit 2d47acf

Browse files
Ssukritidushyantbehlwillmj
authored
chore: Update CONTRIBUTING.md (#501)
* Update CONTRIBUTING.md Signed-off-by: Sukriti Sharma <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Dushyant Behl <[email protected]> Signed-off-by: Sukriti Sharma <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Dushyant Behl <[email protected]> Signed-off-by: Sukriti Sharma <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Will Johnson <[email protected]> Signed-off-by: Sukriti Sharma <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Dushyant Behl <[email protected]> Signed-off-by: Sukriti Sharma <[email protected]> * Update CONTRIBUTING.md Signed-off-by: Sukriti Sharma <[email protected]> --------- Signed-off-by: Sukriti Sharma <[email protected]> Co-authored-by: Dushyant Behl <[email protected]> Co-authored-by: Will Johnson <[email protected]>
1 parent 9d4ba71 commit 2d47acf

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,11 @@ 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 in the PR description.
35+
2. We require new unit tests to be contributed with any new functionality added.
36+
3. We require each feature to be documented as part of the PR. If certain feature is experimental and not documented it will be announced as a dev preview.
37+
4. We require any new unit tests that are gated by conditions such as package availability must be executed, and details of those along with a screenshot of the test results should be included in the PR description.
3538

3639
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).
3740

@@ -50,6 +53,8 @@ Once you've [created a pull request](#how-can-i-contribute), maintainers will re
5053
- Follow the project coding conventions
5154
- Write detailed commit messages
5255
- Break large changes into a logical series of smaller patches, which are easy to understand individually and combine to solve a broader issue
56+
- Ensure documentation is added on `how to use` any new capabilities.
57+
- Ensure follow-up issues are created for documentation and that feature is not officially released without full documentation.
5358

5459
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.
5560

0 commit comments

Comments
 (0)