Skip to content

Commit acf63a9

Browse files
author
Cecile Robert-Michon
committed
📖 improve CONTRIBUTING.md PR process
1 parent 4f2a760 commit acf63a9

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

.github/pull_request_template.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- If this is your first PR, welcome! Please make sure you read the [contributing guidelines](../CONTRIBUTING.md). -->
2+
13
**What this PR does / why we need it**:
24

35
**Which issue(s) this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close the issue(s) when PR gets merged)*:

CONTRIBUTING.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,22 @@ If you're new to the project and want to help, but don't know where to start, we
3030
## Contributing a Patch
3131

3232
1. If you haven't already done so, sign a Contributor License Agreement (see details above).
33-
1. Fork the desired repo, develop and test your code changes.
34-
1. Submit a pull request.
35-
1. All code PR must be labeled with
36-
⚠️ (:warning:, major or breaking changes), ✨ (:sparkles:, minor or feature additions), 🐛 (:bug:, patch and bugfixes), 📖 (:book:, documentation or proposals), or 🏃 (:running:, other)
33+
2. Fork the desired repo, develop and test your code changes.
34+
1. See the [Development Guide](docs/development.md) for more instructions on setting up your environment and testing changes locally.
35+
3. Submit a pull request.
36+
1. All PRs should be labeled with one of
37+
- ⚠️ (:warning:, major or breaking changes)
38+
- ✨ (:sparkles:, feature additions)
39+
- 🐛 (:bug:, patch and bug fixes)
40+
- 📖 (:book:, documentation or proposals)
41+
- 💚 (:green_heart:, testing)
42+
- 💎 (:gem:, refactor)
43+
- 🔧 (:wrench:, dev tooling and chores)
44+
- 🌱 (:seedling:, update dependencies, minor or other)
45+
2. All code changes must be covered by unit tests and E2E tests.
46+
3. All new features should come with user documentation.
47+
4. Once the PR has been reviewed and is ready to be merged, commits should be [squashed](https://github.com/kubernetes/community/blob/master/contributors/guide/github-workflow.md#squash-commits).
48+
1. Ensure that commit message(s) are be meaningful and commit history is readable.
3749

3850
All changes must be code reviewed. Coding conventions and standards are explained in the official [developer docs](https://github.com/kubernetes/community/tree/master/contributors/devel). Expect reviewers to request that you avoid common [go style mistakes](https://github.com/golang/go/wiki/CodeReviewComments) in your PRs.
3951

0 commit comments

Comments
 (0)