Skip to content

Commit 1c9aa53

Browse files
committed
Add issue templates for tf-pre-commit
Signed-off-by: Dalwar Hossain <5631766+dalwar23@users.noreply.github.com>
1 parent 7b88dd7 commit 1c9aa53

5 files changed

Lines changed: 165 additions & 1 deletion

File tree

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: "❓Ask a question"
2+
description: "Ask a question about tf-pre-commit"
3+
labels: [question]
4+
body:
5+
- type: textarea
6+
id: related-issues
7+
validations:
8+
required: true
9+
attributes:
10+
label: "📑 I have found these related issues/pull requests"
11+
description: "Search related issues by clicking [HERE](https://github.com/devopsforhumans/tf-pre-commit/issues)"
12+
placeholder: "Related to #1"
13+
- type: textarea
14+
id: question
15+
validations:
16+
required: false
17+
attributes:
18+
label: "❓ Question"
19+
description: "Ask your question here."
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: "🐛 Bug Report"
2+
description: "Submit a bug report to help us improve"
3+
labels: [bug]
4+
body:
5+
- type: textarea
6+
id: related-issues
7+
validations:
8+
required: true
9+
attributes:
10+
label: "👉 I have found these related issues/pull requests"
11+
description: "Search related issues by clicking [HERE](https://github.com/devopsforhumans/tf-pre-commit/issues)"
12+
placeholder: "Related to #1"
13+
- type: textarea
14+
id: description
15+
validations:
16+
required: false
17+
attributes:
18+
label: "📝 Description"
19+
description: "You could also upload screenshots"
20+
- type: textarea
21+
id: steps-to-reproduce
22+
validations:
23+
required: true
24+
attributes:
25+
label: "👟 Reproduction steps"
26+
description: "How do you trigger this bug? Please walk us through it step by step. Include all important details and add screenshots where appropriate"
27+
placeholder: "..."
28+
- type: textarea
29+
id: expected-behavior
30+
validations:
31+
required: true
32+
attributes:
33+
label: "👀 Expected behavior"
34+
description: "What did you think would happen?"
35+
placeholder: "..."
36+
- type: textarea
37+
id: actual-behavior
38+
validations:
39+
required: true
40+
attributes:
41+
label: "😓 Actual Behavior"
42+
description: "What actually happen?"
43+
placeholder: "..."
44+
- type: input
45+
id: tf-pre-commit-version
46+
attributes:
47+
label: "🐻 tf-pre-commit Version"
48+
description: "Which version of tf-pre-commit are you running?"
49+
placeholder: "Ex. 0.0.1-alpha.6"
50+
validations:
51+
required: true
52+
- type: input
53+
id: operating-system
54+
attributes:
55+
label: "💻 Operating System and Arch"
56+
description: "Which OS is your server/device running on?"
57+
placeholder: "Ex. Ubuntu 20.04 x64 "
58+
validations:
59+
required: true
60+
- type: textarea
61+
id: deployment-info
62+
attributes:
63+
label: "🖥️ Deployment Environment"
64+
description: |
65+
examples:
66+
- **Python**: python 3.9/python 3.10/python 3.11
67+
- **Terraform**: terraform version
68+
- **pre-commit**: pre-commit version
69+
value: |
70+
- Python:
71+
- Terraform:
72+
- pre-commit:
73+
validations:
74+
required: true
75+
- type: textarea
76+
id: logs
77+
attributes:
78+
label: "🪵 Relevant log output"
79+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
80+
render: shell
81+
validations:
82+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: 🚀 Feature Request
2+
description: "Submit a proposal for a new feature"
3+
labels: [feature-request, enhancement]
4+
body:
5+
- type: textarea
6+
id: related-issues
7+
validations:
8+
required: true
9+
attributes:
10+
label: "📑 I have found these related issues/pull requests"
11+
description: "Search related issues by clicking [HERE](https://github.com/devopsforhumans/tf-pre-commit/issues)"
12+
placeholder: "Related to #1"
13+
- type: dropdown
14+
id: feature-area
15+
attributes:
16+
label: "🏷️ Feature Request Type"
17+
description: "What kind of feature request is this?"
18+
multiple: true
19+
options:
20+
- Automation options
21+
- New notification-provider
22+
- New monitor
23+
- Change to existing monitor
24+
- Status-page
25+
- Maintenance
26+
- Incidents
27+
- Settings
28+
- Other
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: feature-description
33+
validations:
34+
required: true
35+
attributes:
36+
label: "🔖 Feature description"
37+
description: "A clear and concise description of what the feature request is."
38+
placeholder: "You should add ... because it will help user .... to do ....."
39+
- type: textarea
40+
id: solution
41+
validations:
42+
required: true
43+
attributes:
44+
label: "✔️ Solution"
45+
description: "A clear and concise description of what you want to happen."
46+
placeholder: "In my use-case, ..."
47+
- type: textarea
48+
id: alternatives
49+
validations:
50+
required: false
51+
attributes:
52+
label: "❓ Alternatives"
53+
description: "A clear and concise description of any alternative solutions or features you've considered."
54+
placeholder: "I have considered ..."
55+
- type: textarea
56+
id: additional-context
57+
validations:
58+
required: false
59+
attributes:
60+
label: "📝 Additional Context"
61+
description: "Add any other context or screenshots about the feature request here."
62+
placeholder: "..."

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ if you want to provide `options` or `global options` (try `terraform fmt --help`
3333
hooks:
3434
id: terraform-fmt
3535
args:
36-
- --option="-no-color -diff -check"
36+
- --options="-no-color -diff -check"
3737
...
3838
```
3939

0 commit comments

Comments
 (0)