From 5fbd8bd18e84e286a07a5b560a67822334636eb2 Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Fri, 21 Jun 2024 11:52:48 -0700 Subject: [PATCH] Use issue templates (#251) 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.yml | 67 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++ .github/ISSUE_TEMPLATE/feature-request.yml | 58 +++++++++++++++++++ .github/ISSUE_TEMPLATE/maintainers-only.md | 12 ++++ 4 files changed, 145 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/maintainers-only.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..ef2aa53 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,67 @@ +name: Report a problem +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), + 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 + validations: + required: true + + - type: textarea + id: runner-os + 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 + validations: + required: true + + - type: textarea + id: cpp-linter-config + 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 + validations: + required: true + + - type: textarea + id: what-happened + 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 + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..8c3ec94 --- /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 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/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.