Skip to content

Commit

Permalink
chore: add templates for bug reports and feature requests (#299)
Browse files Browse the repository at this point in the history
* add bug report template

* add feature request template

* prevent users from creating blank issues (i.e. force them to use a template)

* fix config file extension
  • Loading branch information
lvaylet committed Nov 25, 2022
1 parent d355e5b commit 6e947de
Show file tree
Hide file tree
Showing 3 changed files with 130 additions and 0 deletions.
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG-REPORT.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: "🐛 Bug Report"
description: File a bug report.
title: "🐛 [BUG] - <title>"
labels: [
"bug",
"triage",
]
assignees:
- lvaylet
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: input
id: slo-generator-version
attributes:
label: SLO Generator Version
description: Which version of SLO Generator are you using?
placeholder: ex. v1.5.0, v2.3.3
validations:
required: true
- type: input
id: python-version
attributes:
label: Python Version
description: Which version of Python are you using?
placeholder: ex. 2.7, 3.10
validations:
required: true
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Please provide as many details as possible, including SLO definitions and shared config. Ideally reproduction steps too, so we can troubleshoot the issue on our own machines.
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: what-did-you-expect
attributes:
label: What did you expect?
description: What did you expect to happen?
placeholder: Tell us what you expected!
validations:
required: true
- type: textarea
id: screenshot
attributes:
label: "Screenshots"
description: If applicable, add screenshots to help explain your problem.
value: |
![DESCRIPTION](LINK.png)
render: bash
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.
render: shell
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/google/slo-generator/blob/master/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: "💡 Feature Request"
description: File a new feature request.
title: "💡 [REQUEST] - <title>"
labels: [
"question"
]
body:
- type: textarea
id: summary
attributes:
label: "Summary"
description: Provide a brief explanation of the feature.
placeholder: Describe in a few lines your feature request.
validations:
required: true
- type: textarea
id: basic_example
attributes:
label: "Basic Example"
description: Indicate here some basic examples of your feature.
placeholder: A few specific words about your feature request.
validations:
required: true
- type: textarea
id: screenshot
attributes:
label: "Screenshots"
description: If applicable, add screenshots to help explain your problem.
value: |
![DESCRIPTION](LINK.png)
render: bash
validations:
required: false
- type: textarea
id: drawbacks
attributes:
label: "Drawbacks"
description: What are the drawbacks/impacts of your feature request ?
placeholder: Identify the drawbacks and impacts while being neutral on your feature request.
validations:
required: true
- type: textarea
id: unresolved_question
attributes:
label: "Unresolved questions"
description: What questions still remain unresolved ?
placeholder: Identify any unresolved issues.
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/google/slo-generator/blob/master/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false

0 comments on commit 6e947de

Please sign in to comment.