diff options
| author | vishakha <vishakhanihore.10@gmail.com> | 2019-12-19 04:33:14 +0530 |
|---|---|---|
| committer | vishakha <vishakhanihore.10@gmail.com> | 2019-12-19 18:09:10 +0530 |
| commit | 497de1e4bf0b13aae6a046faeb5a3ad90aaf0d90 (patch) | |
| tree | 8bb68909d30c6bfe636dcfbd39bfc33a054941be | |
| parent | 78fbbbe371855e86846713a51d5a2bbea1adbec6 (diff) | |
Including contributions best practices
| -rw-r--r-- | contributors/guide/README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/contributors/guide/README.md b/contributors/guide/README.md index e95d3704..059f98d4 100644 --- a/contributors/guide/README.md +++ b/contributors/guide/README.md @@ -36,6 +36,7 @@ Welcome to Kubernetes! - [GitHub workflow](#github-workflow) - [Open a Pull Request](#open-a-pull-request) - [Code Review](#code-review) + - [Contributions best practices](#contributions-best-practices) - [Testing](#testing) - [Security](#security) - [Documentation](#documentation) @@ -234,6 +235,18 @@ When reviewing PRs from others [The Gentle Art of Patch Review](http://sage.thes Note: if your pull request isn't getting enough attention, you can use the [#pr-reviews](https://kubernetes.slack.com/messages/pr-reviews) channel on Slack to get help finding reviewers. +## Contributions best practices + +- Write clear and meaningful git commit messages. +- If the PR will *completely* fix a specific issue, include `fixes #123` in the PR body (where 123 is the specific issue number the PR will fix. This will automatically close the issue when the PR is merged. +- Make sure you don't include `@mentions` or `fixes` keywords in your git commit messages. These should be included in the PR body instead. +- When you make a PR for small change (such as fixing a typo, style change, or grammar fix), please squash your commits so that we can maintain a cleaner git history. +- Make sure you include a clear and detailed PR description explaining the reasons for the changes, and ensuring there is sufficient information for the reviewer to understand your PR. +- Additional Readings : + - [chris.beams.io/posts/git-commit/](https://chris.beams.io/posts/git-commit/) + - [github.com/blog/1506-closing-issues-via-pull-requests ](https://github.com/blog/1506-closing-issues-via-pull-requests ) + - [davidwalsh.name/squash-commits-git ](https://davidwalsh.name/squash-commits-git ) + ## Testing Testing is the responsibility of all contributors and is in part owned by all SIGs, but is also coordinated by [sig-testing](/sig-testing). |