From c74141ce44005f01e44d16402495c02a246b1d29 Mon Sep 17 00:00:00 2001 From: Ludvig Liljenberg Date: Wed, 26 Feb 2025 18:49:02 -0800 Subject: [PATCH 1/4] Document label meaning Signed-off-by: Ludvig Liljenberg --- .github/release.yml | 31 ++++------------------- docs/github-labels.md | 58 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+), 26 deletions(-) create mode 100644 docs/github-labels.md diff --git a/.github/release.yml b/.github/release.yml index ded8aea0a..c1d170881 100644 --- a/.github/release.yml +++ b/.github/release.yml @@ -3,32 +3,11 @@ changelog: exclude: labels: - - chore + - release-notes/ignore categories: - - title: πŸ›  Breaking Changes + - title: New Features or Improvements labels: - - breaking-change - - title: πŸŽ‰ New Features + - kind/enhancement + - title: Bug Fixes labels: - - enhancement - - title: πŸ› Bug Fixes - labels: - - bug - - title: πŸ”’ Security Fixes - labels: - - security - - title: πŸš€ Performance Improvements - labels: - - performance - - title: πŸ‘’ Dependencies - labels: - - dependencies - - title: πŸ“š Documentation - labels: - - documentation - - title: πŸ”¬ Testing - labels: - - testing - - title: πŸ“ Other Changes - labels: - - "*" + - kind/bugfix diff --git a/docs/github-labels.md b/docs/github-labels.md new file mode 100644 index 000000000..17444deaf --- /dev/null +++ b/docs/github-labels.md @@ -0,0 +1,58 @@ +# **PRs** + +To categorize PRs, we use GitHub labels. Before a PR can be merged, it must be assigned one of the following **kind/** labels, as these labels are used to generate automatic release notes: + +- **kind/enhancement** - For PRs that add new features or improve existing functionality. This label should also be applied to PRs that improve documentation and testing, for example. +- **kind/bugfix** - For PRs that resolve bugs. +- **kind/refactor** - For PRs that improve code without changing its behavior. +- **kind/dependencies** - For PRs that update dependencies or related components. + +## PR release notes + +GitHub release notes are automatically generated from PRs based on the assigned **kind/** labels, along with the PR title. To exclude PRs from release notes, add the **release-notes/ignore** label. + +--- + +# **Issues** + +Issues are categorized using the following three **GitHub types** (not GitHub labels): + +- **bug** - Reports an unexpected problem or incorrect behavior. +- **enhancement** - Suggests a new feature, improvement, or idea. +- **design** - Relates to design considerations or decisions. + +To track the lifecycle of issues, we also use GitHub labels: + +- **lifecycle/needs-review** - A temporary label indicating that the issue has not yet been reviewed. +- **lifecycle/confirmed** - Confirms the issue’s validity: + - If the issue type is **bug**, the bug has been verified. + - If the issue type is **enhancement**, the proposal has been deemed ready for implementation. + - This label does not indicate when the fix or enhancement will be implemented. +- **lifecycle/needs-info** - The issue requires additional information from the original poster (OP). +- **lifecycle/blocked** - The issue is blocked by another issue or external factor. + +The following labels should be applied to issues prior to closing, indicating the resolution status of the issue: + +- **lifecycle/fixed** - The issue has been resolved. +- **lifecycle/duplicate** - The issue is a duplicate of another issue. +- **lifecycle/not-a-bug** - The issue is not considered a bug, and no further action is needed. +- **lifecycle/wont-fix** - The issue will not be fixed. + +In addition to lifecycle labels, we use the following labels to further categorize issues: + +- **question** - The issue is a question or request for information. +- **help-wanted** - The issue is a request for help or assistance. +- **good-first-issue** - The issue is suitable for new contributors or those looking for a simple task to start with. + +--- + +# **Issues & PRs** + +In addition to **kind/*** labels, we use optional **area/*** labels to specify the focus of a PR or issue. These labels are purely for categorization, are not mandatory, and are not used for release notes. + +- **area/documentation** – Related to documentation updates or improvements. +- **area/API** – Related to the API or public interface. +- **area/infrastructure** – Concerns infrastructure rather than core functionality. +- **area/performance** – Addresses performance. +- **area/security** – Involves security-related changes or fixes. +- **area/testing** – Related to tests or testing infrastructure. \ No newline at end of file From 31b83d37c9b3fc0b91213a6d6a058b950ee13618 Mon Sep 17 00:00:00 2001 From: Ludvig Liljenberg Date: Tue, 11 Mar 2025 13:15:51 -0700 Subject: [PATCH 2/4] Don't mention release notes in docs Signed-off-by: Ludvig Liljenberg --- .github/release.yml | 31 ++++++++++++++++++++++++++----- docs/github-labels.md | 8 ++------ 2 files changed, 28 insertions(+), 11 deletions(-) diff --git a/.github/release.yml b/.github/release.yml index c1d170881..ded8aea0a 100644 --- a/.github/release.yml +++ b/.github/release.yml @@ -3,11 +3,32 @@ changelog: exclude: labels: - - release-notes/ignore + - chore categories: - - title: New Features or Improvements + - title: πŸ›  Breaking Changes labels: - - kind/enhancement - - title: Bug Fixes + - breaking-change + - title: πŸŽ‰ New Features labels: - - kind/bugfix + - enhancement + - title: πŸ› Bug Fixes + labels: + - bug + - title: πŸ”’ Security Fixes + labels: + - security + - title: πŸš€ Performance Improvements + labels: + - performance + - title: πŸ‘’ Dependencies + labels: + - dependencies + - title: πŸ“š Documentation + labels: + - documentation + - title: πŸ”¬ Testing + labels: + - testing + - title: πŸ“ Other Changes + labels: + - "*" diff --git a/docs/github-labels.md b/docs/github-labels.md index 17444deaf..8688c359e 100644 --- a/docs/github-labels.md +++ b/docs/github-labels.md @@ -1,16 +1,12 @@ # **PRs** -To categorize PRs, we use GitHub labels. Before a PR can be merged, it must be assigned one of the following **kind/** labels, as these labels are used to generate automatic release notes: +To categorize PRs, we use GitHub labels. Before a PR can be merged, it must be assigned one of the following **kind/** labels. - **kind/enhancement** - For PRs that add new features or improve existing functionality. This label should also be applied to PRs that improve documentation and testing, for example. - **kind/bugfix** - For PRs that resolve bugs. - **kind/refactor** - For PRs that improve code without changing its behavior. - **kind/dependencies** - For PRs that update dependencies or related components. -## PR release notes - -GitHub release notes are automatically generated from PRs based on the assigned **kind/** labels, along with the PR title. To exclude PRs from release notes, add the **release-notes/ignore** label. - --- # **Issues** @@ -48,7 +44,7 @@ In addition to lifecycle labels, we use the following labels to further categori # **Issues & PRs** -In addition to **kind/*** labels, we use optional **area/*** labels to specify the focus of a PR or issue. These labels are purely for categorization, are not mandatory, and are not used for release notes. +In addition to **kind/*** labels, we use optional **area/*** labels to specify the focus of a PR or issue. These labels are purely for categorization, and are not mandatory. - **area/documentation** – Related to documentation updates or improvements. - **area/API** – Related to the API or public interface. From 0da914c51808df85422e6952c30f426591fb4759 Mon Sep 17 00:00:00 2001 From: Ludvig Liljenberg Date: Thu, 13 Mar 2025 17:44:24 -0700 Subject: [PATCH 3/4] Some feedback Signed-off-by: Ludvig Liljenberg --- docs/github-labels.md | 50 +++++++++++++++++++++++-------------------- 1 file changed, 27 insertions(+), 23 deletions(-) diff --git a/docs/github-labels.md b/docs/github-labels.md index 8688c359e..371e63cc3 100644 --- a/docs/github-labels.md +++ b/docs/github-labels.md @@ -1,29 +1,29 @@ -# **PRs** +# **Pull Requests (PRs)** -To categorize PRs, we use GitHub labels. Before a PR can be merged, it must be assigned one of the following **kind/** labels. +We use GitHub labels to categorize PRs. Before a PR can be merged, it must be assigned one of the following **kind/** labels: -- **kind/enhancement** - For PRs that add new features or improve existing functionality. This label should also be applied to PRs that improve documentation and testing, for example. -- **kind/bugfix** - For PRs that resolve bugs. -- **kind/refactor** - For PRs that improve code without changing its behavior. +- **kind/enhancement** - For PRs that introduce new features or improve existing functionality. This label also applies to improvements in documentation, testing, and similar areas. Any changes must be backward-compatible. +- **kind/bugfix** - For PRs that fix bugs. +- **kind/refactor** - For PRs that restructure or remove code without adding new functionality. This label also applies to changes that affect user-facing APIs. - **kind/dependencies** - For PRs that update dependencies or related components. --- -# **Issues** +# **Issues** -Issues are categorized using the following three **GitHub types** (not GitHub labels): +Issues are categorized using the following three **GitHub types** (not GitHub labels): -- **bug** - Reports an unexpected problem or incorrect behavior. -- **enhancement** - Suggests a new feature, improvement, or idea. -- **design** - Relates to design considerations or decisions. +- **bug** - Reports an unexpected problem or incorrect behavior. +- **enhancement** - Suggests a new feature, improvement, or idea. +- **design** - Relates to design considerations or decisions. -To track the lifecycle of issues, we also use GitHub labels: +To track the lifecycle of issues, we also use GitHub labels: -- **lifecycle/needs-review** - A temporary label indicating that the issue has not yet been reviewed. -- **lifecycle/confirmed** - Confirms the issue’s validity: - - If the issue type is **bug**, the bug has been verified. - - If the issue type is **enhancement**, the proposal has been deemed ready for implementation. - - This label does not indicate when the fix or enhancement will be implemented. +- **lifecycle/needs-review** - A temporary label indicating that the issue has not yet been reviewed. +- **lifecycle/confirmed** - Confirms the issue’s validity: + - If the issue type is **bug**, the bug has been verified. + - If the issue type is **enhancement**, the proposal is considered reasonable but does not guarantee implementation. + - This label does not indicate when or if the fix or enhancement will be implemented. - **lifecycle/needs-info** - The issue requires additional information from the original poster (OP). - **lifecycle/blocked** - The issue is blocked by another issue or external factor. @@ -42,13 +42,17 @@ In addition to lifecycle labels, we use the following labels to further categori --- -# **Issues & PRs** +# **Issues & PRs** In addition to **kind/*** labels, we use optional **area/*** labels to specify the focus of a PR or issue. These labels are purely for categorization, and are not mandatory. -- **area/documentation** – Related to documentation updates or improvements. -- **area/API** – Related to the API or public interface. -- **area/infrastructure** – Concerns infrastructure rather than core functionality. -- **area/performance** – Addresses performance. -- **area/security** – Involves security-related changes or fixes. -- **area/testing** – Related to tests or testing infrastructure. \ No newline at end of file +- **area/documentation** - Related to documentation updates or improvements. +- **area/API** - Related to the API or public interface. +- **area/infrastructure** - Concerns infrastructure rather than core functionality. +- **area/performance** - Addresses performance. +- **area/security** - Involves security-related changes or fixes. +- **area/testing** - Related to tests or testing infrastructure. + + +## Notes +This document is a work in progress and may be updated as needed. The labels and categories are subject to change based on the evolving needs of the project and community feedback. \ No newline at end of file From 6c9b3f0b6a86d612b8842687ff3943f0a4913073 Mon Sep 17 00:00:00 2001 From: Ludvig Liljenberg Date: Mon, 17 Mar 2025 14:09:09 -0700 Subject: [PATCH 4/4] order alphabetically Signed-off-by: Ludvig Liljenberg --- docs/github-labels.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/github-labels.md b/docs/github-labels.md index 371e63cc3..888b0280d 100644 --- a/docs/github-labels.md +++ b/docs/github-labels.md @@ -2,10 +2,10 @@ We use GitHub labels to categorize PRs. Before a PR can be merged, it must be assigned one of the following **kind/** labels: -- **kind/enhancement** - For PRs that introduce new features or improve existing functionality. This label also applies to improvements in documentation, testing, and similar areas. Any changes must be backward-compatible. - **kind/bugfix** - For PRs that fix bugs. -- **kind/refactor** - For PRs that restructure or remove code without adding new functionality. This label also applies to changes that affect user-facing APIs. - **kind/dependencies** - For PRs that update dependencies or related components. +- **kind/enhancement** - For PRs that introduce new features or improve existing functionality. This label also applies to improvements in documentation, testing, and similar areas. Any changes must be backward-compatible. +- **kind/refactor** - For PRs that restructure or remove code without adding new functionality. This label also applies to changes that affect user-facing APIs. --- @@ -14,8 +14,8 @@ We use GitHub labels to categorize PRs. Before a PR can be merged, it must be as Issues are categorized using the following three **GitHub types** (not GitHub labels): - **bug** - Reports an unexpected problem or incorrect behavior. -- **enhancement** - Suggests a new feature, improvement, or idea. - **design** - Relates to design considerations or decisions. +- **enhancement** - Suggests a new feature, improvement, or idea. To track the lifecycle of issues, we also use GitHub labels: @@ -29,16 +29,16 @@ To track the lifecycle of issues, we also use GitHub labels: The following labels should be applied to issues prior to closing, indicating the resolution status of the issue: -- **lifecycle/fixed** - The issue has been resolved. - **lifecycle/duplicate** - The issue is a duplicate of another issue. +- **lifecycle/fixed** - The issue has been resolved. - **lifecycle/not-a-bug** - The issue is not considered a bug, and no further action is needed. - **lifecycle/wont-fix** - The issue will not be fixed. In addition to lifecycle labels, we use the following labels to further categorize issues: -- **question** - The issue is a question or request for information. -- **help-wanted** - The issue is a request for help or assistance. - **good-first-issue** - The issue is suitable for new contributors or those looking for a simple task to start with. +- **help-wanted** - The issue is a request for help or assistance. +- **question** - The issue is a question or request for information. --- @@ -46,8 +46,9 @@ In addition to lifecycle labels, we use the following labels to further categori In addition to **kind/*** labels, we use optional **area/*** labels to specify the focus of a PR or issue. These labels are purely for categorization, and are not mandatory. -- **area/documentation** - Related to documentation updates or improvements. - **area/API** - Related to the API or public interface. +- **area/dependencies** - Concerns dependencies or related components. This label is different from **kind/dependencies**, which should only used for PRs. +- **area/documentation** - Related to documentation updates or improvements. - **area/infrastructure** - Concerns infrastructure rather than core functionality. - **area/performance** - Addresses performance. - **area/security** - Involves security-related changes or fixes.