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