[maint] Add issue templates (#2604)

This commit is contained in:
Keegan Campbell
2022-11-04 12:58:38 -07:00
committed by GitHub
parent a6a74c29af
commit 1d9847081b
4 changed files with 188 additions and 0 deletions

41
.github/ISSUE_TEMPLATE/bug.yml vendored Normal file
View File

@@ -0,0 +1,41 @@
name: Bug
description: File a bug report
title: "[BUG]: "
labels: ["Type: Bug", "Status: Triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: What did you do? What happened? What did you expect to happen?
placeholder: Put your description of the bug here.
validations:
required: true
- type: textarea
id: versions
attributes:
label: Versions
description: What versions of the relevant software are you running?
placeholder: Octokit.js v2.0.10, Node v16.18.0
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
Please check your logs before submission to ensure sensitive information is redacted.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true

View File

@@ -0,0 +1,49 @@
name: Documentation
description: Update or add documentation
title: "[DOCS]: "
labels: ["Type: Documentation", "Status: Triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill this out!
- type: textarea
id: describe-need
attributes:
label: Describe the need
description: What do you wish was different about our docs?
placeholder: Describe the need for documentation updates here.
validations:
required: true
- type: input
id: sdk_version
attributes:
label: SDK Version
description: Do these docs apply to a specific SDK version?
placeholder: Octokit.NET v4.0.1
validations:
required: false
- type: input
id: api_version
attributes:
label: API Version
description: Do these docs apply to a specific version of the GitHub REST API or GraphQL API?
placeholder: ex. v1.1.1
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
Please check your logs before submission to ensure sensitive information is redacted.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true

49
.github/ISSUE_TEMPLATE/feature.yml vendored Normal file
View File

@@ -0,0 +1,49 @@
name: Feature
description: Suggest an idea for a new feature or enhancement
title: "[FEAT]: "
labels: ["Type: Feature", "Status: Triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill this out!
- type: textarea
id: describe-need
attributes:
label: Describe the need
description: What do you want to happen? What problem are you trying to solve?
placeholder: Describe the need for the feature.
validations:
required: true
- type: input
id: sdk_version
attributes:
label: SDK Version
description: Does this feature suggestion apply to a specific SDK version?
placeholder: Octokit.rb v6.0.0
validations:
required: false
- type: input
id: api_version
attributes:
label: API Version
description: Does this feature suggestion apply to a specific version of the GitHub REST API or GraphQL API?
placeholder: ex. v1.1.1
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
Please check your logs before submission to ensure sensitive information is redacted.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true

49
.github/ISSUE_TEMPLATE/maintenance.yml vendored Normal file
View File

@@ -0,0 +1,49 @@
name: Maintenance
description: Dependencies, cleanup, refactoring, reworking of code
title: "[MAINT]: "
labels: ["Type: Maintenance", "Status: Triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill this out!
- type: textarea
id: describe-need
attributes:
label: Describe the need
description: What do you want to happen?
placeholder: Describe the maintenance need here.
validations:
required: true
- type: input
id: sdk_version
attributes:
label: SDK Version
description: Does this maintenance apply to a specific SDK version?
placeholder: terraform-provider-github v5.7.0
validations:
required: false
- type: input
id: api_version
attributes:
label: API Version
description: Does this maintenance apply to a specific version of the GitHub REST API or GraphQL API?
placeholder: ex. v1.1.1
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
Please check your logs before submission to ensure sensitive information is redacted.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true