Skip to content

Commit 5fbd8bd

Browse files
2bndy52bndy5
authored
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
1 parent 820b182 commit 5fbd8bd

File tree

4 files changed

+145
-0
lines changed

4 files changed

+145
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: Report a problem
2+
description: Create a report to let us help you
3+
body:
4+
- type: textarea
5+
attributes:
6+
label: What events trigger your workflow?
7+
id: ci-triggers
8+
description: >-
9+
Please copy and paste the workflow triggers.
10+
If you are using a resuable workflow (`workflow_dispatch` event),
11+
then please also include the workflow triggers that the calling workflow uses.
12+
placeholder: |-
13+
on:
14+
pull_request:
15+
branches: [main, master, develop]
16+
paths: ['**.c', '**.cpp', '**.h', '**.hpp', '**.cxx', '**.hxx', '**.cc', '**.hh', '**CMakeLists.txt', 'meson.build', '**.cmake']
17+
push:
18+
branches: [main, master, develop]
19+
paths: ['**.c', '**.cpp', '**.h', '**.hpp', '**.cxx', '**.hxx', '**.cc', '**.hh', '**CMakeLists.txt', 'meson.build', '**.cmake']
20+
render: yml
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: runner-os
26+
attributes:
27+
label: What OS does your workflow use?
28+
description: >-
29+
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).
30+
If you are using an additional [`container`](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idcontainer),
31+
then please also include that information here.
32+
placeholder: |-
33+
runs-on: ubuntu-latest
34+
container: node:18
35+
render: yml
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: cpp-linter-config
41+
attributes:
42+
label: How is cpp-linter-action configured?
43+
description: >-
44+
Please copy and paste the version and inputs used to run cpp-linter-action.
45+
placeholder: |-
46+
- uses: cpp-linter/cpp-linter-action@v2
47+
id: linter
48+
env:
49+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
50+
with:
51+
style: 'file'
52+
tidy-checks: ''
53+
render: yml
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
id: what-happened
59+
attributes:
60+
label: What was the unexpected behavior?
61+
description: >-
62+
Use this area to describe what behavior you expected and what behavior you observed.
63+
Please be clear and concise as possible. Use screenshots if that would help. Most users
64+
use this to paste the workflow logs.
65+
placeholder: You can use markdown syntax here
66+
validations:
67+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# this setting will force users to use the provided issue templates
2+
blank_issues_enabled: false
3+
# if the templates provided don't fit the subject of the user feedback,
4+
# here we can give links to other forms of user feedback
5+
contact_links:
6+
- name: cpp-linter discussions
7+
url: https://github.com/orgs/cpp-linter/discussions
8+
about: A place for feedback not specific to cpp-linter-action

‎.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
name: Feature request
3+
description: Suggest an idea for this project
4+
body:
5+
- type: dropdown
6+
id: existing-feature
7+
attributes:
8+
label: Is your idea related to an existing feature?
9+
description: >-
10+
If this idea is related to an already available feature(s), then please list them here.
11+
multiple: true
12+
options:
13+
- version
14+
- thread-comments
15+
- tidy-checks
16+
- style
17+
- lines-changed-only
18+
- ignore
19+
- tidy-ignore
20+
- format-ignore
21+
- files-changed-only
22+
- file-annotations
23+
- step-summary
24+
- no-lgtm
25+
- tidy-review
26+
- format-review
27+
- passive-reviews
28+
- verbosity
29+
- 'output: checks-failed'
30+
- 'output: clang-tidy-checks-failed'
31+
- 'output: clang-format-checks-failed'
32+
33+
- type: textarea
34+
id: behavior
35+
attributes:
36+
label: Describe the behavior you would like
37+
description: >-
38+
Use this area to describe what behavior you desire.
39+
Please be clear and concise as possible. Use screenshots if that would help.
40+
placeholder: You can use markdown syntax here
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: alternative
46+
attributes:
47+
label: Describe alternatives you have considered
48+
description: >-
49+
Were you able to achieve the desired behavior in some other/inconvenient way?
50+
placeholder: You can use markdown syntax here
51+
52+
- type: textarea
53+
id: added-context
54+
attributes:
55+
label: Additional context
56+
description: >-
57+
If there is anything that might be special or specific to your usage, please let us know.
58+
placeholder: You can use markdown syntax here

‎.github/ISSUE_TEMPLATE/maintainers-only.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: Maintainers' note
3+
about: For ideas related to maintaining the cpp-linter-action source code
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
This issue template is intended only for maintainers of cpp-linter org.
11+
12+
Only use this issue template if your query is **not** related to a problem or feature.

0 commit comments

Comments
 (0)