Skip to content

Commit

Permalink
Use issue templates (#251)
Browse files Browse the repository at this point in the history
This is so I don't have to keep asking the same set of questions when helping people troubleshoot or consider new features/ideas
  • Loading branch information
2bndy5 authored Jun 21, 2024
1 parent 820b182 commit 5fbd8bd
Show file tree
Hide file tree
Showing 4 changed files with 145 additions and 0 deletions.
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -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
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -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
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/maintainers-only.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 5fbd8bd

Please sign in to comment.