From 616dd5eb7322289c7ef980b2769c3b1cfd75c969 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Vanderheyden?= Date: Mon, 25 Nov 2024 10:39:14 +0100 Subject: [PATCH] feat: add global labels definition (#141) * feat: add global labels definition * chore: update issue templates to new labels --- .github/ISSUE_TEMPLATE/bug-report.md | 40 ------ .github/ISSUE_TEMPLATE/bug-report.yml | 27 +++- .github/ISSUE_TEMPLATE/enhancement.md | 19 --- .github/ISSUE_TEMPLATE/enhancement.yml | 19 +-- .github/ISSUE_TEMPLATE/feature-request.md | 19 --- .github/ISSUE_TEMPLATE/feature-request.yml | 24 ++-- .github/ISSUE_TEMPLATE/other.md | 7 - .github/ISSUE_TEMPLATE/other.yml | 28 ++-- .github/labels.yml | 143 +++++++++++++++++++++ CONTRIBUTING.md | 33 +++++ 10 files changed, 242 insertions(+), 117 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md delete mode 100644 .github/ISSUE_TEMPLATE/enhancement.md delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md delete mode 100644 .github/ISSUE_TEMPLATE/other.md create mode 100644 .github/labels.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 11001f4..0000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: "πŸ› Bug report" -about: Create a bug report to help us improve -title: "πŸ› " -labels: 'πŸ‘€ needs triage', 'πŸ› bug' -assignees: '' ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - -- OS: [e.g. iOS] -- Browser [e.g. chrome, safari] -- Version [e.g. 22] - -**Smartphone (please complete the following information):** - -- Device: [e.g. iPhone6] -- OS: [e.g. iOS8.1] -- Browser [e.g. stock browser, safari] -- Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 7df04ae..3c09097 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,6 +1,6 @@ name: 'πŸ› Bug report' description: Report a bug/problem -labels: ['πŸ› bug', 'πŸ‘€ needs triage'] +labels: ['πŸ› bug', 'πŸ‘€ triage'] body: - type: markdown @@ -11,10 +11,11 @@ body: - type: dropdown id: package validations: - required: true + required: false attributes: label: Affected package - description: Which package is affected? + description: Which packages are affected? + multiple: true options: - Core - Components @@ -22,6 +23,24 @@ body: - Docs - Bootstrap + - type: dropdown + validations: + required: false + attributes: + multiple: true + label: In what areas does this bug report apply? + options: + - 'β™Ώ Accessibility' + - 'πŸ€– Build' + - 'πŸ” CI/CD' + - 'πŸ“¦ Components' + - 'πŸ“„ Documentation' + - 'πŸ”₯ Performance' + - 'πŸ” Security' + - '🎨 Styles' + - 'βœ… Tests' + - '🀷 Other' + - type: textarea id: what-happened validations: @@ -51,7 +70,7 @@ body: - type: dropdown id: platforms validations: - required: true + required: false attributes: label: What platforms does this bug report apply to? description: You may select more than one. diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md deleted file mode 100644 index 50a7be5..0000000 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: "πŸ“ˆ Enhancement" -about: Suggest an idea to improve this project -title: "πŸ“ˆ " -labels: 'πŸ‘€ needs triage', 'πŸ“ˆ enhancement' -assignees: '' ---- - -**Is your enhancement request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml index 9f5cd9d..1792d0e 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.yml +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -1,6 +1,6 @@ name: 'πŸ“ˆ Enhancement' description: Suggest an idea to improve this project -labels: ['πŸ“ˆ enhancement', 'πŸ‘€ needs triage'] +labels: ['πŸ’‘ feature', 'πŸ‘€ triage'] body: - type: markdown @@ -24,19 +24,20 @@ body: - type: dropdown validations: - required: true + required: false attributes: - multiple: false - label: Type of feature - description: Select the type of feature request, the lowercase should also be the PR prefix. + multiple: true + label: What area would this enhancement affect? options: - 'β™Ώ Accessibility' - 'πŸ€– Build' - - 'πŸ” CI' + - 'πŸ” CI/CD' + - 'πŸ“¦ Components' + - 'πŸ“„ Documentation' - 'πŸ”₯ Performance' - - 'πŸ§‘β€πŸ’» Refactor' - - '🎨 Style' - - 'βœ… Test' + - 'πŸ” Security' + - '🎨 Styles' + - 'βœ… Tests' - '🀷 Other' - type: textarea diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 1ac1fc1..0000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: 'πŸ™ Feature request' -about: Suggest an idea for this project -title: 'πŸ’‘ ' -labels: 'πŸ‘€ needs triage', 'πŸ’‘ feature' -assignees: '' ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 6cac74e..39d3935 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,6 +1,6 @@ name: 'πŸ™ Feature request' description: Suggest a new feature for this project -labels: ['πŸ’‘ feature', 'πŸ‘€ needs triage'] +labels: ['πŸ’‘ feature', 'πŸ‘€ triage'] body: - type: markdown @@ -9,18 +9,22 @@ body: Thanks for taking the time to fill out this feature request! - type: dropdown - id: package validations: - required: true + required: false attributes: - label: Affected package - description: Which package is affected? + multiple: true + label: What area would this new feature affect? options: - - Core - - Components - - Icons - - Docs - - Bootstrap + - 'β™Ώ Accessibility' + - 'πŸ€– Build' + - 'πŸ” CI/CD' + - 'πŸ“¦ Components' + - 'πŸ“„ Documentation' + - 'πŸ”₯ Performance' + - 'πŸ” Security' + - '🎨 Styles' + - 'βœ… Tests' + - '🀷 Other' - type: textarea id: what-happened diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md deleted file mode 100644 index 410c8e1..0000000 --- a/.github/ISSUE_TEMPLATE/other.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -name: '🀷 Other' -about: Everything that doesn't fit in the other categories -title: '' -labels: 'πŸ‘€ needs triage' -assignees: '' ---- diff --git a/.github/ISSUE_TEMPLATE/other.yml b/.github/ISSUE_TEMPLATE/other.yml index 5af6f26..d8020e4 100644 --- a/.github/ISSUE_TEMPLATE/other.yml +++ b/.github/ISSUE_TEMPLATE/other.yml @@ -1,6 +1,6 @@ name: '🀷 Other' description: Everything that doesn't fit in the other categories -labels: ['πŸ‘€ needs triage'] +labels: ['πŸ‘€ triage'] body: - type: markdown @@ -22,21 +22,31 @@ body: - Docs - Bootstrap - - type: textarea - id: what-happened + - type: dropdown validations: - required: true + required: false attributes: - label: Current behavior - description: Is your feature request related to a problem? Please describe. + multiple: true + label: What area is affected? + options: + - 'β™Ώ Accessibility' + - 'πŸ€– Build' + - 'πŸ” CI/CD' + - 'πŸ“¦ Components' + - 'πŸ“„ Documentation' + - 'πŸ”₯ Performance' + - 'πŸ” Security' + - '🎨 Styles' + - 'βœ… Tests' + - '🀷 Other' - type: textarea id: suggested-solution validations: - required: false + required: true attributes: - label: Suggested enhancement - description: Describe the enhancement you'd like. + label: Desciption + description: Describe what you'd like to change. - type: input id: context diff --git a/.github/labels.yml b/.github/labels.yml new file mode 100644 index 0000000..d71de0d --- /dev/null +++ b/.github/labels.yml @@ -0,0 +1,143 @@ +# +# Configuration file with all labels used accross the organization +# +# Each label is defined by: +# - name: The name of the label. +# - color: The color of the label, with or without a leading #. +# - description: [optional] The description of the label (max 100 characters). +# - aliases: [optional] An array containing the "aliases" of the label. If an existing label's name is an alias that label will be edited to match your config: this way you don't loose issues and PRs that have been labeled previously. + +# Type ******************************************************************************************************************** + +- name: πŸ› bug + color: 'd73a4a' + description: Something isn't working + aliases: ['bug'] + +- name: πŸ’‘ feature + color: '0e8a16' + description: Adding a new feature or enhancing an existing one + aliases: ['feature', 'πŸ“ˆ enhancement', 'enhancement'] + +- name: ♻️ devops + color: '006B75' + description: Anything related to CI/CD, deployment, or infrastructure + aliases: ['♻️ CI/CD', 'CI/CD', 'devops', 'ci', 'πŸ› οΈ tools', 'tools', 'build'] + +- name: πŸ§ͺ labs + color: '0619E4' + description: Experimental features or prototypes that may not be ready for production + aliases: ['labs', 'πŸ§ͺ research', 'research'] + +- name: 🎨 design + color: 'B99023' + description: Tasks for the design team + aliases: ['design', 'πŸ–ΌοΈ visual', '🎨 needs design', 'needs design'] + +- name: πŸ§‘β€πŸ’» dev + color: 'B99023' + description: Tasks for the development team + aliases: ['dev', 'development', 'code'] + +# Status ****************************************************************************************************************** + +- name: ⁉️ invalid + color: 'e4e669' + description: This doesn't seem right + aliases: ['invalid'] + +- name: πŸ“‹ duplicate + color: 'cfd3d7' + description: This issue or pull request already exists + aliases: ['duplicate'] + +- name: πŸ‘€ triage + color: 'B99023' + description: New issues that have not been reviewed yet + aliases: ['πŸ‘€ needs triage', 'needs triage'] + +- name: ❕wontfix + color: 'ffffff' + description: This will not be worked on + aliases: ['wontfix'] + +- name: πŸ›‘ blocked + color: 'F9D0C4' + aliases: ['blocked', 'second', 'third'] + +- name: πŸš€ released + color: 'ededed' + aliases: ['released'] + +- name: πŸš€ released on @alpha + color: 'ededed' + aliases: ['released'] + +- name: πŸš€ released on @beta + color: 'ededed' + aliases: ['released'] + +- name: πŸš€ released on @next + color: 'ededed' + aliases: ['released'] + +# Severity **************************************************************************************************************** + +- name: ‼️ critical + color: '870501' + description: A very inspiring description + aliases: ['critical'] + +# Target ****************************************************************************************************************** + +- name: πŸ” security + color: 'B60205' + description: Security vulnerabilities + aliases: ['security'] + +- name: β™Ώ a11y + color: '0052CC' + description: Accessibility + aliases: ['a11y', 'Accessibility'] + +- name: css + color: '870501' + description: Pull requests that update CSS code + aliases: ['css', 'styles'] + +- name: javascript + color: '870501' + description: Pull requests that update Javascript code + aliases: ['javascript', 'typescript'] + +- name: ⛓️ dependencies + color: '0366d6' + description: Pull requests that update a dependency file + aliases: ['dependencies', 'deps'] + +- name: πŸ“„ docs + color: '0075ca' + description: Improvements or additions to documentation + aliases: ['docs'] + +- name: βš™οΈ github_actions + color: '000000' + description: Pull requests that update GitHub Actions code + aliases: ['github_actions'] + +# Misc ******************************************************************************************************************** + +- name: πŸ‘ good first issue + color: '7057ff' + description: Good for newcomers + aliases: ['good first issue'] + +- name: πŸ†˜ help wanted + color: '008672' + description: Extra attention is needed + aliases: ['help wanted'] + +- name: ❔ question + color: 'd876e3' + description: Further information is requested + aliases: ['question'] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 416d2b9..90f9f99 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -142,6 +142,39 @@ Here are a addit few things you can do that will increase the likelihood of your - Write tests whenever applicable. - Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. +### Labels + +We use the following labels to help organize and identify issues and pull requests: + +| Label Name | Type | Description | +| --------------------- | -------- | -------------------------------------------------------- | +| πŸ› bug | Type | Something isn't working | +| πŸ’‘ feature | Type | Adding a new feature or enhancing an existing one | +| ♻️ devops | Type | Anything related to CI/CD, deployment, or infrastructure | +| πŸ§ͺ labs | Type | Experimental features or prototypes | +| 🎨 design | Type | Tasks for the design team | +| πŸ§‘β€πŸ’» dev | Type | Tasks for the development team | +| ⁉️ invalid | Status | This doesn't seem right | +| πŸ“‹ duplicate | Status | This issue or pull request already exists | +| πŸ‘€ triage | Status | New issues that have not been reviewed yet | +| ❕wontfix | Status | This will not be worked on | +| πŸ›‘ blocked | Status | This issue is blocked | +| πŸš€ released | Status | This issue has been released | +| πŸš€ released on @alpha | Status | This issue has been released on alpha | +| πŸš€ released on @beta | Status | This issue has been released on beta | +| πŸš€ released on @next | Status | This issue has been released on next | +| ‼️ critical | Severity | A very inspiring description | +| πŸ” security | Target | Security vulnerabilities | +| β™Ώ a11y | Target | Accessibility | +| css | Target | Pull requests that update CSS code | +| javascript | Target | Pull requests that update Javascript code | +| ⛓️ dependencies | Target | Pull requests that update a dependency file | +| πŸ“„ docs | Target | Improvements or additions to documentation | +| βš™οΈ github_actions | Target | Pull requests that update GitHub Actions code | +| πŸ‘ good first issue | Misc | Good for newcomers | +| πŸ†˜ help wanted | Misc | Extra attention is needed | +| ❔ question | Misc | Further information is requested | + ## Styleguides ### Branche name