Skip to content

Commit 64ad080

Browse files
committed
chore: issue templates modified, CHANGELOG updated for introducing issue template
1 parent e26e063 commit 64ad080

File tree

3 files changed

+28
-12
lines changed

3 files changed

+28
-12
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ name: Bug report
33
about: Create a report to help us improve
44
title: "[BUG]: <Issue Title>"
55
labels: bug
6-
assignees: ''
7-
6+
assignees: ""
87
---
98

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

1312
**To Reproduce**
1413
Steps to reproduce the behavior:
14+
1515
1. Go to '...'
1616
2. Click on '....'
1717
3. Scroll down to '....'
@@ -23,10 +23,14 @@ A clear and concise description of what you expected to happen.
2323
**Screenshots**
2424
If applicable, add screenshots to help explain your problem.
2525

26-
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
26+
**System & Environment**
27+
28+
- OS: [Windows/macOS/Linux and version]
29+
- Processor: [e.g., Intel Core i7-9700K]
30+
- Installed RAM: [e.g., 16 GB]
31+
- GPU Enabled: [Yes/No and model if applicable]
32+
- Terminal: [e.g., Windows Terminal, zsh, bash, etc.]
33+
- Python environment: [e.g., 3.12.10 (through Python virtual environment)]
3034

3135
**Additional context**
3236
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,33 @@ name: Question
33
about: If you have any question...
44
title: "[QUESTION]: <Issue Title>"
55
labels: question
6-
assignees: ''
7-
6+
assignees: ""
87
---
98

109
**Your Question**
1110
A clear and concise question about the project.
1211

1312
**What I've Already Tried**
1413
Describe what you've already attempted or researched.
14+
1515
- Checked the documentation: [Yes/No]
1616
- Searched existing issues: [Yes/No]
1717
- Tried: [describe any attempts]
1818

1919
**Context**
2020
Provide any relevant context that might help answer your question.
21+
2122
- What are you trying to achieve?
2223
- What's your use case?
2324

24-
**Environment (if relevant)**
25-
- OS: [e.g. Windows, macOS, Linux]
26-
- Version: [e.g. 1.2.3]
27-
- Other relevant details: [e.g. Python 3.9, Node 18]
25+
**System & Environment (If relevant)**
26+
27+
- OS: [Windows/macOS/Linux and version]
28+
- Processor: [e.g., Intel Core i7-9700K]
29+
- Installed RAM: [e.g., 16 GB]
30+
- GPU Enabled: [Yes/No and model if applicable]
31+
- Terminal: [e.g., Windows Terminal, zsh, bash, etc.]
32+
- Python environment: [e.g., 3.12.10 (through Python virtual environment)]
2833

2934
**Additional context**
3035
Add any other context, code snippets, or screenshots that might help.

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
### Added
44

5+
- Template for GitHub issues added to [.github/ISSUE_TEMPLATE](https://github.com/slimeslab/ComProScanner/tree/main/.github/ISSUE_TEMPLATE) for the following topics:
6+
7+
- bug reports
8+
- feature requests
9+
- documentation improvements
10+
- support questions
11+
512
- [Changelog page](https://slimeslab.github.io/ComProScanner/about/changelog/) added in the documentation. Also, [CHANGELOG.md](https://github.com/slimeslab/ComProScanner/blob/main/CHANGELOG.md) linked in [README.md](https://github.com/slimeslab/ComProScanner/blob/main/README.md).
613

714
- Added DeepWiki integration badge to README.md for community Q&A support:

0 commit comments

Comments
 (0)