Skip to content

Commit

Permalink
Merge pull request gridhead#231 from TAKI12T/bug-report-templates
Browse files Browse the repository at this point in the history
Bug report templates
  • Loading branch information
gridhead authored Dec 2, 2024
2 parents d8612ae + 267999f commit befb658
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Bug Report
about: Report a bug or error in the software
title: '[Bug] Issue Title'
labels: 'bug'
assignees: ''

---

**Description of the bug:**
Please describe the bug you encountered. Mention if it's an expected or unexpected behavior.

**Steps to Reproduce:**
1. Go to [X]
2. Click on [Y]
3. See [Z]

**Expected behavior:**
Explain what you expected to happen.

**Actual behavior:**
Explain what actually happened (e.g., errors, unexpected behavior, etc.).

**Screenshots or logs:**
If possible, please provide screenshots or relevant log excerpts to illustrate the issue.

**Environment:**
- Operating system (e.g., Windows, macOS, Linux):
- Python version:
- Software version:
- Any other relevant dependencies or configurations:

**Additional context:**
Add any other context about the problem here. If you have encountered the bug in a specific version, mention that version.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Feature Request
about: Suggest a new feature or improvement
title: '[Feature] Feature Title'
labels: 'enhancement'
assignees: ''

---

**Current problem:**
Describe the problem you're trying to solve. Why is it a problem or inconvenience in the current software?

**Proposed feature:**
Describe clearly the feature or improvement you would like to see added.

**Benefits of this feature:**
Explain why this feature would be beneficial for users or developers. What would it add to the software?

**Usage examples:**
Provide concrete examples or use cases to show how this feature might be used.

**Screenshots or mockups (optional):**
If possible, add any images or mockups to help explain your idea.

**Additional context:**
Add any other context or information that may be relevant for the feature request.

0 comments on commit befb658

Please sign in to comment.