Skip to content

feat: Add GitHub issue templates to enhance contribution workflow #200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug Report
about: Create a report to help us improve
title: '[BUG] '
labels: bug
assignees: ''
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Environment (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
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
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Documentation Update
about: Suggest improvements or report missing/unclear documentation
title: '[DOCS] '
labels: documentation
assignees: ''
---

**Documentation Location**
Please provide the location of the documentation you're referring to.

**Describe the problem**
Is the documentation missing? Unclear? Incorrect? Explain the issue.

**Suggested Improvements**
Describe what changes you think should be made to the documentation.

**Additional context**
Add any other context or screenshots about the documentation request here.
24 changes: 10 additions & 14 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,19 @@
---
name: Feature Request
about: Suggest an idea for this project
title: ''
labels: ''
title: '[FEATURE] '
labels: enhancement
assignees: ''

---

**Description:**
A clear and concise description of the implementation.

**Tasks:**
Add the tasks need to complete to achieve the implementation.
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Acceptance Criteria:**
Implementation should be able to perform these functionalities.
**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Additional Information:**
Add additional information
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Related Dependencies or References:**
Add related dependencies and references relating to the implementation.
**Additional context**
Add any other context or screenshots about the feature request here.