From 921f360e9ea6bcab5fa676a121ba460312af445a Mon Sep 17 00:00:00 2001 From: "NGnius (Graham)" Date: Thu, 13 Jun 2024 18:03:55 -0400 Subject: [PATCH] Add question issue template, update other templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 6 +++--- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature-request.yml | 8 ++++++-- .github/ISSUE_TEMPLATE/question.yml | 23 ++++++++++++++++++++++ 4 files changed, 33 insertions(+), 6 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index e215c1d..2ecbd35 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -20,7 +20,7 @@ body: id: reproduction attributes: label: Steps To Reproduce - description: Steps to reproduce the behavior + description: Steps to reproduce the behaviour. placeholder: | 1. Go to '...' 2. Click on '....' @@ -33,12 +33,12 @@ body: attributes: label: Anything else? description: | - Screenshots? Logs? pt_oc.json? limits_overrides.json? Anything that will give more context about the problem! + Screenshots? Logs? limits_overrides.ron? limits_cache.ron? Anything that will give more context about the problem! If applicable, add screenshots to help explain your problem. Please include the log (located at `/tmp/powertools.log`) if possible. Note: the log is deleted when the device is restarted. - Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + Tip: You can attach files by clicking this area to highlight it and then dragging them in. validations: required: false - type: input diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index a5cd6f9..047d38f 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - name: NGnius - url: https://github.com/NGnius + url: https://git.ngni.us/sys/website/wiki#contact-information about: Repository owner diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 530296a..8c75c82 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -3,7 +3,7 @@ description: Suggest functionality to add labels: "enhancement" body: - type: textarea - id: described + id: feature-description attributes: label: Describe what you'd like to be able to do description: A clear and concise description of what you want. @@ -22,7 +22,11 @@ body: id: extras attributes: label: Anything else? - description: Description of how this can be achieved, or other additional context + description: | + Description of how this can be achieved, or other additional context. + If this is related to the UI, consider adding a picture. + + Tip: You can attach files by clicking this area to highlight it and then dragging them in. placeholder: This can be accomplished by doing ... validations: required: false diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..a4209ab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,23 @@ +name: "Question" +description: "Ask for more information about PowerTools" +labels: "question" +body: + - type: textarea + id: question-elaboration + attributes: + label: Question + description: | + A clear and concise description of what you'd like to know. + Please check the wiki and closed issues to avoid waiting for an answer when you didn't need to. + validations: + required: true + - type: textarea + id: extras + attributes: + label: Extra Info + description: | + Additional context or information which may be helpful when answering your question. + + Tip: You can attach files by clicking this area to highlight it and then dragging them in. + validations: + required: false