From 50d94fd9ecb4cb04d0ec6c9f72ed0ebe327d3d31 Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Thu, 20 Jun 2024 22:34:20 -0700 Subject: [PATCH] update templates based on tests in our test repo --- .../{bug_report.md => bug-report.yml} | 21 ++++--- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature-request.yml | 58 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 36 ------------ 4 files changed, 73 insertions(+), 44 deletions(-) rename .github/ISSUE_TEMPLATE/{bug_report.md => bug-report.yml} (87%) create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug-report.yml similarity index 87% rename from .github/ISSUE_TEMPLATE/bug_report.md rename to .github/ISSUE_TEMPLATE/bug-report.yml index 64e75bc..ef2aa53 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,14 +1,10 @@ ---- name: Report a problem -about: Create a report to let us help you -title: '' -labels: [] -assignees: '' - +description: Create a report to let us help you body: - type: textarea attributes: label: What events trigger your workflow? + id: ci-triggers description: >- Please copy and paste the workflow triggers. If you are using a resuable workflow (`workflow_dispatch` event), @@ -22,8 +18,11 @@ body: branches: [main, master, develop] paths: ['**.c', '**.cpp', '**.h', '**.hpp', '**.cxx', '**.hxx', '**.cc', '**.hh', '**CMakeLists.txt', 'meson.build', '**.cmake'] render: yml + validations: + required: true - type: textarea + id: runner-os attributes: label: What OS does your workflow use? description: >- @@ -34,8 +33,11 @@ body: runs-on: ubuntu-latest container: node:18 render: yml + validations: + required: true - type: textarea + id: cpp-linter-config attributes: label: How is cpp-linter-action configured? description: >- @@ -49,12 +51,17 @@ body: style: 'file' tidy-checks: '' render: yml + validations: + required: true - type: textarea + id: what-happened attributes: label: What was the unexpected behavior? - description: |- + description: >- Use this area to describe what behavior you expected and what behavior you observed. Please be clear and concise as possible. Use screenshots if that would help. Most users use this to paste the workflow logs. placeholder: You can use markdown syntax here + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index e15b0e9..8c3ec94 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,7 +2,7 @@ blank_issues_enabled: false # if the templates provided don't fit the subject of the user feedback, # here we can give links to other forms of user feedback -contact-links: +contact_links: - name: cpp-linter discussions url: https://github.com/orgs/cpp-linter/discussions about: A place for feedback not specific to cpp-linter-action diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..39a4d77 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,58 @@ +--- +name: Feature request +description: Suggest an idea for this project +body: + - type: dropdown + id: existing-feature + attributes: + label: Is your idea related to an existing feature? + description: >- + If this idea is related to an already available feature(s), then please list them here. + multiple: true + options: + - version + - thread-comments + - tidy-checks + - style + - lines-changed-only + - ignore + - tidy-ignore + - format-ignore + - files-changed-only + - file-annotations + - step-summary + - no-lgtm + - tidy-review + - format-review + - passive-reviews + - verbosity + - 'output: checks-failed' + - 'output: clang-tidy-checks-failed' + - 'output: clang-format-checks-failed' + + - type: textarea + id: behavior + attributes: + label: Describe the behavior you would like + description: >- + Use this area to describe what behavior you desire. + Please be clear and concise as possible. Use screenshots if that would help. + placeholder: You can use markdown syntax here + validations: + required: true + + - type: textarea + id: alternative + attributes: + label: Describe alternatives you have considered + description: >- + Were you able to achieve the desired behavior in some other/inconvenient way? + placeholder: You can use markdown syntax here + + - type: textarea + id: added-context + attributes: + label: Additional context + description: >- + If there is anything that might be special or specific to your usage, please let us know. + placeholder: You can use markdown syntax here diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 33d8fd7..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: [] -assignees: '' - -body: - - - type: input - label: Is your idea related to an existing feature? - description: |- - If this idea is related to an already available feature(s), then please list them here. - placeholder: 'Example: lines-changed-only, thread-comments, ...' - - - type: textarea - attributes: - label: Describe the behavior you would like - description: |- - Use this area to describe what behavior you desire. - Please be clear and concise as possible. Use screenshots if that would help. - placeholder: You can use markdown syntax here - - - type: textarea - attributes: - label: Describe alternatives you have considered - description: |- - Were you able to achieve the desired behavior in some other/inconvenient way? - placeholder: You can use markdown syntax here - - - type: textarea - attributes: - label: Additional context - description: |- - If there is anything that might be special or specific to your usage, please let us know. - placeholder: You can use markdown syntax here