Skip to content

Commit

Permalink
add issue template (#61)
Browse files Browse the repository at this point in the history
Signed-off-by: Manabu Mccloskey <[email protected]>
  • Loading branch information
nabuskey authored Oct 25, 2023
1 parent 519f693 commit ff13799
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: 🐞 Bug Report
title: "[Bug]: <title>"
description: Create a report to help us improve
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
### How to write a good bug report?
- Respect the issue template as much as possible.
- The title should be short and descriptive.
- Explain the conditions which led you to report this issue and the context.
- The context should lead to something, an idea or a problem that you’re facing.
- Remain clear and concise.
- Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown)
- type: textarea
attributes:
label: What is your environment, configuration, and command?
description: |
Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
placeholder: Add information here.
validations:
required: true

- type: textarea
attributes:
label: What did you do and What did you see instead?
description: |
Provide error details and the expected details.
Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
placeholder: Add information here.
validations:
required: true

- type: textarea
attributes:
label: Additional Information. Logs.
description: Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
placeholder: Add information here.
render: shell
validations:
required: false
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: true

0 comments on commit ff13799

Please sign in to comment.