From f3053dde648fc8200bc48b4b7efad8864558d25c Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Thu, 20 Jun 2024 13:49:25 -0700 Subject: [PATCH 1/6] Use issue templates This is so I don't have to keep asking the same set of questions when helping people troubleshoot or consider new features/ideas --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..f3d5c41 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: 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/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..11fc491 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +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. From fdd42745ebd7c50990213840d9607475615afe2b Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Thu, 20 Jun 2024 21:06:05 -0700 Subject: [PATCH 2/6] switch to forms instead of unrestrained markdown input --- .github/ISSUE_TEMPLATE/bug_report.md | 86 ++++++++++++++--------- .github/ISSUE_TEMPLATE/feature_request.md | 33 ++++++--- 2 files changed, 75 insertions(+), 44 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f3d5c41..4ca4bca 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,38 +1,56 @@ --- -name: Bug report -about: Create a report to help us improve +name: Report a problem +about: Create a report to let us help you title: '' -labels: bug +labels: [] 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. +body: + - type: textarea + label: What events trigger your workflow? + description: >- + Please copy and paste the workflow triggers. + If you are using a resuable workflow (`workflow_dispatch` event), + then please also include the workflow triggers that the calling workflow uses. + placeholder: |- + on: + pull_request: + branches: [main, master, develop] + paths: ['**.c', '**.cpp', '**.h', '**.hpp', '**.cxx', '**.hxx', '**.cc', '**.hh', '**CMakeLists.txt', 'meson.build', '**.cmake'] + push: + branches: [main, master, develop] + paths: ['**.c', '**.cpp', '**.h', '**.hpp', '**.cxx', '**.hxx', '**.cc', '**.hh', '**CMakeLists.txt', 'meson.build', '**.cmake'] + render: yml + + - type: textarea + label: What OS does your workflow use? + description: >- + Please tell us what OS the workflow [`runs-on`](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on). + If you are using an additional [`container`](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idcontainer), + then please also include that information here. + placeholder: |- + runs-on: ubuntu-latest + container: node:18 + render: yml + + - type: textarea + label: How is cpp-linter-action configured? + description: >- + Please copy and paste the version and inputs used to run cpp-linter-action. + placeholder: |- + - uses: cpp-linter/cpp-linter-action@v2 + id: linter + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + style: 'file' + tidy-checks: '' + render: yml + + - type: markdown + label: What was the unexpected behavior? + 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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 11fc491..e1ff6a0 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,19 +2,32 @@ name: Feature request about: Suggest an idea for this project title: '' -labels: enhancement +labels: [] assignees: '' ---- +body: -**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 [...] + - 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, ...' -**Describe the solution you'd like** -A clear and concise description of what you want to happen. + - type: markdown + 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 -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. + - type: markdown + 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 -**Additional context** -Add any other context or screenshots about the feature request here. + - type: markdown + 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 From 11658263d63cb138ce63d31224f516d27edd17ff Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Thu, 20 Jun 2024 21:25:48 -0700 Subject: [PATCH 3/6] don't allow blank issue template instead provide another avenue for feedback --- .github/ISSUE_TEMPLATE/config.yml | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..e15b0e9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +# this setting will force users to use the provided issue templates +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: + - name: cpp-linter discussions + url: https://github.com/orgs/cpp-linter/discussions + about: A place for feedback not specific to cpp-linter-action From eaee5555dae07f1e6a00efc9b45237a9c8100b16 Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Thu, 20 Jun 2024 21:40:01 -0700 Subject: [PATCH 4/6] self review --- .github/ISSUE_TEMPLATE/bug_report.md | 88 ++++++++++++----------- .github/ISSUE_TEMPLATE/feature_request.md | 35 ++++----- 2 files changed, 65 insertions(+), 58 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 4ca4bca..64e75bc 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,50 +7,54 @@ assignees: '' body: - type: textarea - label: What events trigger your workflow? - description: >- - Please copy and paste the workflow triggers. - If you are using a resuable workflow (`workflow_dispatch` event), - then please also include the workflow triggers that the calling workflow uses. - placeholder: |- - on: - pull_request: - branches: [main, master, develop] - paths: ['**.c', '**.cpp', '**.h', '**.hpp', '**.cxx', '**.hxx', '**.cc', '**.hh', '**CMakeLists.txt', 'meson.build', '**.cmake'] - push: - branches: [main, master, develop] - paths: ['**.c', '**.cpp', '**.h', '**.hpp', '**.cxx', '**.hxx', '**.cc', '**.hh', '**CMakeLists.txt', 'meson.build', '**.cmake'] - render: yml + attributes: + label: What events trigger your workflow? + description: >- + Please copy and paste the workflow triggers. + If you are using a resuable workflow (`workflow_dispatch` event), + then please also include the workflow triggers that the calling workflow uses. + placeholder: |- + on: + pull_request: + branches: [main, master, develop] + paths: ['**.c', '**.cpp', '**.h', '**.hpp', '**.cxx', '**.hxx', '**.cc', '**.hh', '**CMakeLists.txt', 'meson.build', '**.cmake'] + push: + branches: [main, master, develop] + paths: ['**.c', '**.cpp', '**.h', '**.hpp', '**.cxx', '**.hxx', '**.cc', '**.hh', '**CMakeLists.txt', 'meson.build', '**.cmake'] + render: yml - type: textarea - label: What OS does your workflow use? - description: >- - Please tell us what OS the workflow [`runs-on`](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on). - If you are using an additional [`container`](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idcontainer), - then please also include that information here. - placeholder: |- - runs-on: ubuntu-latest - container: node:18 - render: yml + attributes: + label: What OS does your workflow use? + description: >- + Please tell us what OS the workflow [`runs-on`](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on). + If you are using an additional [`container`](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idcontainer), + then please also include that information here. + placeholder: |- + runs-on: ubuntu-latest + container: node:18 + render: yml - type: textarea - label: How is cpp-linter-action configured? - description: >- - Please copy and paste the version and inputs used to run cpp-linter-action. - placeholder: |- - - uses: cpp-linter/cpp-linter-action@v2 - id: linter - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - style: 'file' - tidy-checks: '' - render: yml + attributes: + label: How is cpp-linter-action configured? + description: >- + Please copy and paste the version and inputs used to run cpp-linter-action. + placeholder: |- + - uses: cpp-linter/cpp-linter-action@v2 + id: linter + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + style: 'file' + tidy-checks: '' + render: yml - - type: markdown - label: What was the unexpected behavior? - 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 + - type: textarea + attributes: + label: What was the unexpected behavior? + 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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index e1ff6a0..33d8fd7 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -13,21 +13,24 @@ body: If this idea is related to an already available feature(s), then please list them here. placeholder: 'Example: lines-changed-only, thread-comments, ...' - - type: markdown - 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 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: markdown - 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: 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: markdown - 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 + - 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 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 5/6] 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 From 9118e52632b029568e416552ec2aa9312c9e4aaf Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Fri, 21 Jun 2024 09:01:55 -0700 Subject: [PATCH 6/6] add blank template for maintainers --- .github/ISSUE_TEMPLATE/maintainers-only.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/maintainers-only.md diff --git a/.github/ISSUE_TEMPLATE/maintainers-only.md b/.github/ISSUE_TEMPLATE/maintainers-only.md new file mode 100644 index 0000000..5a8eea2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/maintainers-only.md @@ -0,0 +1,12 @@ +--- +name: Maintainers' note +about: For ideas related to maintaining the cpp-linter-action source code +title: '' +labels: '' +assignees: '' + +--- + +This issue template is intended only for maintainers of cpp-linter org. + +Only use this issue template if your query is **not** related to a problem or feature.