Skip to content

Commit a614e6c

Browse files
kfcampbellkfcampbell
authoredNov 7, 2022
[maint] Add issue templates
·
v5.1.2v3.0.3
1 parent 63e5e69 commit a614e6c

File tree

4 files changed

+188
-0
lines changed

4 files changed

+188
-0
lines changed
 

‎.github/ISSUE_TEMPLATE/bug.yml

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Bug
2+
description: File a bug report
3+
title: "[BUG]: "
4+
labels: ["Type: Bug", "Status: Triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
- type: textarea
11+
id: what-happened
12+
attributes:
13+
label: What happened?
14+
description: What did you do? What happened? What did you expect to happen?
15+
placeholder: Put your description of the bug here.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: versions
20+
attributes:
21+
label: Versions
22+
description: What versions of the relevant software are you running?
23+
placeholder: Octokit.js v2.0.10, Node v16.18.0
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: logs
28+
attributes:
29+
label: Relevant log output
30+
description: |
31+
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
32+
Please check your logs before submission to ensure sensitive information is redacted.
33+
render: shell
34+
- type: checkboxes
35+
id: terms
36+
attributes:
37+
label: Code of Conduct
38+
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
39+
options:
40+
- label: I agree to follow this project's Code of Conduct
41+
required: true

‎.github/ISSUE_TEMPLATE/documentation.yml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Documentation
2+
description: Update or add documentation
3+
title: "[DOCS]: "
4+
labels: ["Type: Documentation", "Status: Triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill this out!
10+
- type: textarea
11+
id: describe-need
12+
attributes:
13+
label: Describe the need
14+
description: What do you wish was different about our docs?
15+
placeholder: Describe the need for documentation updates here.
16+
validations:
17+
required: true
18+
- type: input
19+
id: sdk_version
20+
attributes:
21+
label: SDK Version
22+
description: Do these docs apply to a specific SDK version?
23+
placeholder: Octokit.NET v4.0.1
24+
validations:
25+
required: false
26+
- type: input
27+
id: api_version
28+
attributes:
29+
label: API Version
30+
description: Do these docs apply to a specific version of the GitHub REST API or GraphQL API?
31+
placeholder: ex. v1.1.1
32+
validations:
33+
required: false
34+
- type: textarea
35+
id: logs
36+
attributes:
37+
label: Relevant log output
38+
description: |
39+
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
40+
Please check your logs before submission to ensure sensitive information is redacted.
41+
render: shell
42+
- type: checkboxes
43+
id: terms
44+
attributes:
45+
label: Code of Conduct
46+
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
47+
options:
48+
- label: I agree to follow this project's Code of Conduct
49+
required: true

‎.github/ISSUE_TEMPLATE/feature.yml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Feature
2+
description: Suggest an idea for a new feature or enhancement
3+
title: "[FEAT]: "
4+
labels: ["Type: Feature", "Status: Triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill this out!
10+
- type: textarea
11+
id: describe-need
12+
attributes:
13+
label: Describe the need
14+
description: What do you want to happen? What problem are you trying to solve?
15+
placeholder: Describe the need for the feature.
16+
validations:
17+
required: true
18+
- type: input
19+
id: sdk_version
20+
attributes:
21+
label: SDK Version
22+
description: Does this feature suggestion apply to a specific SDK version?
23+
placeholder: Octokit.rb v6.0.0
24+
validations:
25+
required: false
26+
- type: input
27+
id: api_version
28+
attributes:
29+
label: API Version
30+
description: Does this feature suggestion apply to a specific version of the GitHub REST API or GraphQL API?
31+
placeholder: ex. v1.1.1
32+
validations:
33+
required: false
34+
- type: textarea
35+
id: logs
36+
attributes:
37+
label: Relevant log output
38+
description: |
39+
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
40+
Please check your logs before submission to ensure sensitive information is redacted.
41+
render: shell
42+
- type: checkboxes
43+
id: terms
44+
attributes:
45+
label: Code of Conduct
46+
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
47+
options:
48+
- label: I agree to follow this project's Code of Conduct
49+
required: true

‎.github/ISSUE_TEMPLATE/maintenance.yml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Maintenance
2+
description: Dependencies, cleanup, refactoring, reworking of code
3+
title: "[MAINT]: "
4+
labels: ["Type: Maintenance", "Status: Triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill this out!
10+
- type: textarea
11+
id: describe-need
12+
attributes:
13+
label: Describe the need
14+
description: What do you want to happen?
15+
placeholder: Describe the maintenance need here.
16+
validations:
17+
required: true
18+
- type: input
19+
id: sdk_version
20+
attributes:
21+
label: SDK Version
22+
description: Does this maintenance apply to a specific SDK version?
23+
placeholder: terraform-provider-github v5.7.0
24+
validations:
25+
required: false
26+
- type: input
27+
id: api_version
28+
attributes:
29+
label: API Version
30+
description: Does this maintenance apply to a specific version of the GitHub REST API or GraphQL API?
31+
placeholder: ex. v1.1.1
32+
validations:
33+
required: false
34+
- type: textarea
35+
id: logs
36+
attributes:
37+
label: Relevant log output
38+
description: |
39+
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
40+
Please check your logs before submission to ensure sensitive information is redacted.
41+
render: shell
42+
- type: checkboxes
43+
id: terms
44+
attributes:
45+
label: Code of Conduct
46+
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
47+
options:
48+
- label: I agree to follow this project's Code of Conduct
49+
required: true

0 commit comments

Comments
 (0)
Please sign in to comment.