Skip to content

Commit

Permalink
docs: setup bug_report.yaml issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
zobweyt committed Oct 5, 2024
1 parent 88c9adf commit 82a2918
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 0 deletions.
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
name: "Bug report"

description: "Create a report to help us improve."

labels:
- bug

assignees:
- zobweyt

body:
- type: markdown
attributes:
value: Thank you for reporting bugs! We appreciate your help in improving our product.

- type: checkboxes
id: existing
attributes:
label: Search for Existing Issues
description: Before submitting a new bug, please ensure you search for existing ones to prevent duplicates.
options:
- label: I've searched the [issues](https://github.com/quotepedia/api/issues?q=is%3Aissue+sort%3Aupdated).
required: true
- label: I've searched the [discussions](https://github.com/quotepedia/api/discussions).
required: true

- type: textarea
id: description
attributes:
label: Bug Description
description: Provide a clear description of what the bug is.
validations:
required: true

- type: input
id: reproduction
attributes:
label: Live Reproduction
description: |
Include an example that can reproduce the bug. We can analyze and fix the bug much faster if you provide it.
Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve.
placeholder: https://github.com/user/repo

- type: textarea
id: steps
attributes:
label: Steps To Reproduce
description: Describe how the bug can be reproduced.
placeholder: |
1. Go to…
2. Open the command prompt…
3. See the error message…
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected Behavior
description: Provide a clear description of what you expected to happen.
placeholder: I expected … but … is happening instead.
validations:
required: true

- type: textarea
id: extra
attributes:
label: Extra Information
description: Include any other context about the bug here.

- type: checkboxes
id: conduct
attributes:
label: Code of Conduct
description: The Code of Conduct creates a safe space for everyone. We require that everyone agrees to it.
options:
- label: I agree this project's [Code of Conduct](https://github.com/quotepedia/api/blob/main/CODE_OF_CONDUCT.md)
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true

0 comments on commit 82a2918

Please sign in to comment.