Skip to content

Commit fdd4274

Browse files
committed
switch to forms instead of unrestrained markdown input
1 parent f3053dd commit fdd4274

File tree

2 files changed

+75
-44
lines changed

2 files changed

+75
-44
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 52 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,56 @@
11
---
2-
name: Bug report
3-
about: Create a report to help us improve
2+
name: Report a problem
3+
about: Create a report to let us help you
44
title: ''
5-
labels: bug
5+
labels: []
66
assignees: ''
77

8-
---
9-
10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
12-
13-
**To Reproduce**
14-
Steps to reproduce the behavior:
15-
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
18-
4. See error
19-
20-
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
22-
23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
25-
26-
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
30-
31-
**Smartphone (please complete the following information):**
32-
- Device: [e.g. iPhone6]
33-
- OS: [e.g. iOS8.1]
34-
- Browser [e.g. stock browser, safari]
35-
- Version [e.g. 22]
36-
37-
**Additional context**
38-
Add any other context about the problem here.
8+
body:
9+
- type: textarea
10+
label: What events trigger your workflow?
11+
description: >-
12+
Please copy and paste the workflow triggers.
13+
If you are using a resuable workflow (`workflow_dispatch` event),
14+
then please also include the workflow triggers that the calling workflow uses.
15+
placeholder: |-
16+
on:
17+
pull_request:
18+
branches: [main, master, develop]
19+
paths: ['**.c', '**.cpp', '**.h', '**.hpp', '**.cxx', '**.hxx', '**.cc', '**.hh', '**CMakeLists.txt', 'meson.build', '**.cmake']
20+
push:
21+
branches: [main, master, develop]
22+
paths: ['**.c', '**.cpp', '**.h', '**.hpp', '**.cxx', '**.hxx', '**.cc', '**.hh', '**CMakeLists.txt', 'meson.build', '**.cmake']
23+
render: yml
24+
25+
- type: textarea
26+
label: What OS does your workflow use?
27+
description: >-
28+
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).
29+
If you are using an additional [`container`](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idcontainer),
30+
then please also include that information here.
31+
placeholder: |-
32+
runs-on: ubuntu-latest
33+
container: node:18
34+
render: yml
35+
36+
- type: textarea
37+
label: How is cpp-linter-action configured?
38+
description: >-
39+
Please copy and paste the version and inputs used to run cpp-linter-action.
40+
placeholder: |-
41+
- uses: cpp-linter/cpp-linter-action@v2
42+
id: linter
43+
env:
44+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
45+
with:
46+
style: 'file'
47+
tidy-checks: ''
48+
render: yml
49+
50+
- type: markdown
51+
label: What was the unexpected behavior?
52+
description: |-
53+
Use this area to describe what behavior you expected and what behavior you observed.
54+
Please be clear and concise as possible. Use screenshots if that would help. Most users
55+
use this to paste the workflow logs.
56+
placeholder: You can use markdown syntax here

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,32 @@
22
name: Feature request
33
about: Suggest an idea for this project
44
title: ''
5-
labels: enhancement
5+
labels: []
66
assignees: ''
77

8-
---
8+
body:
99

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+
- type: input
11+
label: Is your idea related to an existing feature?
12+
description: |-
13+
If this idea is related to an already available feature(s), then please list them here.
14+
placeholder: 'Example: lines-changed-only, thread-comments, ...'
1215

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
16+
- type: markdown
17+
label: Describe the behavior you would like
18+
description: |-
19+
Use this area to describe what behavior you desire.
20+
Please be clear and concise as possible. Use screenshots if that would help.
21+
placeholder: You can use markdown syntax here
1522

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
23+
- type: markdown
24+
label: Describe alternatives you have considered
25+
description: |-
26+
Were you able to achieve the desired behavior in some other/inconvenient way?
27+
placeholder: You can use markdown syntax here
1828

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
29+
- type: markdown
30+
label: Additional context
31+
description: |-
32+
If there is anything that might be special or specific to your usage, please let us know.
33+
placeholder: You can use markdown syntax here

0 commit comments

Comments
 (0)