Skip to content

Commit

Permalink
Merge pull request #962 from nader-ziada/pr-kind
Browse files Browse the repository at this point in the history
🌱 add a comment for pr authors to include a PR kind
  • Loading branch information
k8s-ci-robot authored Sep 28, 2020
2 parents 110f084 + 521cb92 commit 7a23372
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 13 deletions.
18 changes: 16 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
<!-- If this is your first PR, welcome! Please make sure you read the [contributing guidelines](../CONTRIBUTING.md). -->

<!-- please add an icon to the title of this PR (see ../CONTRIBUTING.md) -->
<!-- the icon will be either ⚠️ (:warning:, major or breaking changes), ✨ (:sparkles:, feature additions), πŸ› (:bug:, patch and bugfixes), πŸ“– (:book:, documentation or proposals), πŸ’š (`:green_heart:`, testing), πŸ’Ž (`:gem:`, refactor), πŸ”§ (`:wrench:`, dev tooling and chores) or 🌱 (:seedling:, minor or other) -->
<!-- Please label this pull request according to what type of issue you are addressing (see ../CONTRIBUTING.md) -->
**What type of PR is this?**

<!--
Add one of the following kinds:
/kind feature
/kind bug
/kind api-change
/kind cleanup
/kind deprecation
/kind design
/kind documentation
/kind failing-test
/kind flake
/kind other
-->

**What this PR does / why we need it**:

Expand Down
25 changes: 14 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,20 @@ If you're new to the project and want to help, but don't know where to start, we
2. Fork the desired repo, develop and test your code changes.
1. See the [Development Guide](docs/development.md) for more instructions on setting up your environment and testing changes locally.
3. Submit a pull request.
1. All PRs should be labeled with one of
- ⚠️ (`:warning:`, major or breaking changes)
- ✨ (`:sparkles:`, feature additions)
- πŸ› (`:bug:`, patch and bug fixes)
- πŸ“– (`:book:`, documentation or proposals)
- πŸ’š (`:green_heart:`, testing)
- πŸ’Ž (`:gem:`, refactor)
- πŸ”§ (`:wrench:`, dev tooling and chores)
- 🌱 (`:seedling:`, update dependencies, minor or other)
2. All code changes must be covered by unit tests and E2E tests.
3. All new features should come with user documentation.
1. All PRs should be labeled with one of the following kinds
- `/kind feature` for PRs releated to adding new features/tests
- `/kind bug` for PRs releated to bug fixes and patches
- `/kind api-change` for PRs releated to adding, removing, or otherwise changing an API
- `/kind cleanup` for PRs releated to code refactoring and cleanup
- `/kind deprecation` for PRs related to a feature/enhancement marked for deprecation.
- `/kind design` for PRs releated to design proposals
- `/kind documentation` for PRs releated to documentation
- `/kind failing-test` for PRs releated to to a consistently or frequently failing test.
- `/kind flake` for PRs related to a flaky test.
- `/kind other` for PRs releated to updating dependencies, minor changes or other
2. If the PR requires additional action from users switching to a new release, include the string "action required" in the PR release-notes.
3. All code changes must be covered by unit tests and E2E tests.
4. All new features should come with user documentation.
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).
1. Ensure that commit message(s) are be meaningful and commit history is readable.

Expand Down

0 comments on commit 7a23372

Please sign in to comment.