Skip to content

Commit

Permalink
Update ISSUE_TEMPLATE
Browse files Browse the repository at this point in the history
Signed-off-by: Tsuyoshi Hombashi <[email protected]>
  • Loading branch information
thombashi committed Mar 1, 2025
1 parent 5a68db4 commit c2141a2
Show file tree
Hide file tree
Showing 5 changed files with 123 additions and 72 deletions.
48 changes: 0 additions & 48 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

73 changes: 73 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
name: Bug Report
description: Report a bug
title: "[Bug]: "
labels: ["needs-triage"]
body:
- type: input
id: title
attributes:
label: Summary
description: "A brief summary of the bug"
placeholder: "e.g., xxx method raises an exception when yyy"
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: "Detailed description of the bug"
placeholder: "A clear and concise description of what the bug is in detail..."
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: "What you expected to happen"
placeholder: "A clear and concise description of what you expected to happen."
validations:
required: true

- type: textarea
id: context
attributes:
label: Context
description: "How has this issue affected you? What are you trying to accomplish?"
placeholder: "Providing context helps us come up with a solution that is most useful in the real world"
validations:
required: false

- type: textarea
id: possible-solution
attributes:
label: Possible Solution
description: "Optional: suggest a fix/reason for the bug or ideas on how to implement the addition or change"
validations:
required: false

- type: textarea
id: code-to-reproduce
attributes:
label: Code to reproduce
description: "How to reproduce the bug with code"
placeholder: Paste the code that reproduces the bug
render: python
validations:
required: true

- type: textarea
id: environment
attributes:
label: Your Environment
description: "Include as many relevant details about the environment you experienced the bug in"
placeholder: |
Please execute the following command and past the output:
```
pip install envinfopy[markdown]
python -m envinfopy --format=markdown SimpleSQLite sqliteschema
```
validations:
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: GitHub Discussions
url: https://github.com/thombashi/SimpleSQLite/discussions
about: Please ask and answer questions here.
- name: Documentation
url: https://simplesqlite.rtfd.io/
about: Please check the documentation before creating an issue.
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Feature Request
description: Suggest an idea for this project
title: "[Feature Request]: "
labels: ["needs-triage"]
body:
- type: textarea
id: feature-description
attributes:
label: Feature Description
description: "Is your feature request related to a problem? Please describe."
placeholder: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]"
validations:
required: true

- type: textarea
id: solution-description
attributes:
label: Solution Description
description: "Describe the solution you'd like"
placeholder: "A clear and concise description of what you want to happen."
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives
description: "Describe alternatives you've considered"
placeholder: "A clear and concise description of any alternative solutions or features you've considered."
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: "Add any other context or screenshots about the feature request here"
placeholder: |
How has this issue affected you? What are you trying to accomplish?
Providing context helps us come up with a solution that is most useful in the real world
validations:
required: false

0 comments on commit c2141a2

Please sign in to comment.