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] 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