From 521cb92d6e81983453df0dcaa9194b2821a014b5 Mon Sep 17 00:00:00 2001 From: Nader Ziada Date: Thu, 24 Sep 2020 15:13:17 -0400 Subject: [PATCH] add a comment in pr template for for pr authors to add a kind this kind will be used by the release note tool to generate the markdown used for the github release --- .github/pull_request_template.md | 18 ++++++++++++++++-- CONTRIBUTING.md | 25 ++++++++++++++----------- 2 files changed, 30 insertions(+), 13 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 85842ac0379..77cdde9a0ee 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,7 +1,21 @@ - - + +**What type of PR is this?** + + **What this PR does / why we need it**: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 83d72b25879..a4b91c7e193 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.