From a20eb260cb328d01dceadc9c03c1564a813fa587 Mon Sep 17 00:00:00 2001 From: ColorfulRhino <131405023+ColorfulRhino@users.noreply.github.com> Date: Thu, 27 Jun 2024 15:59:37 +0200 Subject: [PATCH] github: Improve bug and feature request templates - Add feature request label - Automatically assign the correct label - Slight label and wording improvements --- .github/ISSUE_TEMPLATE/1-bugreport.yml | 14 +++++++------- .github/ISSUE_TEMPLATE/2-feature.yml | 17 ++++++++--------- .github/labels.yml | 17 ++++++++++------- 3 files changed, 25 insertions(+), 23 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1-bugreport.yml b/.github/ISSUE_TEMPLATE/1-bugreport.yml index d2b7d54a5..4877bdcd9 100644 --- a/.github/ISSUE_TEMPLATE/1-bugreport.yml +++ b/.github/ISSUE_TEMPLATE/1-bugreport.yml @@ -1,7 +1,7 @@ -name: Armbian Linux Build Framework Bug Report +name: Bug Report for the Armbian Linux Build Framework description: Create a bug report if there is something wrong with the Armbian build framework. -title: "Problem found ... " -labels: ["bug"] +title: "[Bug]: " +labels: ["Bug"] assignees: "armbian/build-scripts" body: - type: markdown @@ -14,8 +14,8 @@ body: label: What happened? description: | - Also tell us, what did you expect to happen? - placeholder: An error x ocurred when I did y! + Please tell us what you expected to happen and what actually happened. + placeholder: An error x ocurred when I did y! But I expected z to happen. validations: required: true - type: textarea @@ -25,7 +25,7 @@ body: description: | Provide the command you ran or explain the steps you did. - placeholder: Tell us how you did it! E.g. the command you gave to the framework. + placeholder: Tell us step by step how to reproduce the issue! E.g. the command you gave to the framework. validations: required: true - type: dropdown @@ -37,7 +37,7 @@ body: Which branch are you using? options: - main (main development branch) - - other + - other (only relevant in corner cases) validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/2-feature.yml b/.github/ISSUE_TEMPLATE/2-feature.yml index 8af7bbe47..ef08242ac 100644 --- a/.github/ISSUE_TEMPLATE/2-feature.yml +++ b/.github/ISSUE_TEMPLATE/2-feature.yml @@ -1,7 +1,7 @@ -name: Armbian Linux Build Framework Feature request -description: Suggest a feature that you want to see implemented -title: "I would like to ..." -labels: ["feature"] +name: Feature Request for the Armbian Linux Build Framework +description: Suggest a feature that you want to see implemented. +title: "[Feature Request]: " +labels: ["Feature Request"] assignees: "igorpecovnik" body: - type: markdown @@ -12,17 +12,16 @@ body: id: what attributes: label: Which feature would you like to have? - description: "
What do you miss?
" - placeholder: Tell us what is missing! - value: "I think ..." + placeholder: What is missing in your opinion? validations: required: true - type: checkboxes id: financing attributes: label: Funding - description: " - You are welcome to submit your feature request, but keep in mind we can only afford to cover minor tasks. If we decide to.
" + description: | + + You are welcome to submit your feature request, but keep in mind we can only afford to cover minor tasks. If we decide to.
" options: - label: "[I am willing to cover expenses](https://www.armbian.com/contact/)" required: false diff --git a/.github/labels.yml b/.github/labels.yml index c0ae94d36..87a4facbe 100644 --- a/.github/labels.yml +++ b/.github/labels.yml @@ -18,16 +18,19 @@ description: "Can potentially break core functionality" - name: "Bug" color: "F92C01" - description: "Something isn't working well" + description: "Something isn't working as it should" - name: "Bugfix" color: "F92C01" description: "Pull request is fixing a bug" - name: "Discussion" - color: "33B478" - description: "Issue is being discussed. Undetermined." + color: "EDFFE3" + description: "Being discussed - Voice your opinions :)" - name: "Duplicate" color: "f4bd13" description: "Issue is already present" +- name: "Feature Request" + color: "1aac63" + description: "Feature suggestion" - name: "Not framework bug" color: "CD456C" description: "Bug in 3rd party component" @@ -80,11 +83,11 @@ color: "AEE054" description: "Seeking for review" - name: "Can be closed?" - color: "5319e7" - description: "Ping developers on stalled issues / PR" + color: "9b75fc" + description: "Ping developers on stalled issue / PR" - name: "Build" - color: "1d76db" - description: "Executing build train" + color: "5ee3d0" + description: "Executing build train (permission needed)" - name: "Needs Documentation" color: "#4FD1EF" description: "New feature needs documentation entry"