Skip to content

Commit 1103ab0

Browse files
1a1a11ahaochengxiaCopilot
authored
Update issue templates for bug reports and feature requests; add clea… (#215)
* Update issue templates for bug reports and feature requests; add cleanup request template * Update .github/ISSUE_TEMPLATE/bug_report.md Co-authored-by: Copilot <[email protected]> * Update bug_report.md * Update cleanup_request.md * Update feature_request.md * Update bug_report.md --------- Co-authored-by: Percy <[email protected]> Co-authored-by: Copilot <[email protected]>
1 parent 04e47e9 commit 1103ab0

3 files changed

Lines changed: 86 additions & 21 deletions

File tree

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
4-
title: ''
5-
labels: ''
3+
about: Create a report to help us improve libCacheSim
4+
title: '[BUG]: '
5+
labels: 'bug'
66
assignees: ''
77

88
---
@@ -12,27 +12,28 @@ A clear and concise description of what the bug is.
1212

1313
**To Reproduce**
1414
Steps to reproduce the behavior:
15-
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
15+
1. Build libCacheSim with: `bash scripts/debug.sh`
16+
2. Run the command: `./_build_dbg/bin/cachesim ...`
17+
3. Provide input parameters and trace file: `...`
1818
4. See error
1919

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

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
23+
**Environment (please complete the following information):**
24+
- OS: [e.g. Ubuntu 20.04, macOS 12.0, Windows 11]
25+
- Compiler: [e.g. gcc 9.4.0, clang 12.0.0]
26+
- libCacheSim version: [e.g. v0.1.0 or commit hash]
27+
- Build type: [e.g. Debug, Release]
2528

26-
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
29+
**Input data**
30+
If applicable, provide:
31+
- Trace file format and sample data
32+
- Command line arguments used
33+
- Configuration files
3034

31-
**Smartphone (please complete the following information):**
32-
- Device: [e.g. iPhone6]
33-
- OS: [e.g. iOS8.1]
34-
- Browser [e.g. stock browser, safari]
35-
- Version [e.g. 22]
35+
**Error output**
36+
If applicable, add error messages, stack traces, or relevant log output.
3637

3738
**Additional context**
3839
Add any other context about the problem here.
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: Cleanup
3+
about: Report code cleanup, refactoring, or maintenance tasks
4+
title: '[CLEANUP: '
5+
labels: 'cleanup'
6+
assignees: ''
7+
8+
---
9+
10+
**Area of cleanup**
11+
Describe the area of the codebase that needs cleanup (e.g., specific modules, files, or directories).
12+
13+
**Type of cleanup**
14+
- [ ] Code refactoring
15+
- [ ] Remove deprecated code
16+
- [ ] Update dependencies
17+
- [ ] Improve documentation
18+
- [ ] Code formatting/style consistency
19+
- [ ] Remove unused code/variables
20+
- [ ] Performance optimization
21+
- [ ] Memory leak fixes
22+
- [ ] Other (please specify)
23+
24+
**Current state**
25+
Describe the current state of the code that needs cleanup. What makes it messy or problematic?
26+
27+
**Proposed improvements**
28+
Describe what the cleaned-up code should look like. What improvements do you suggest?
29+
30+
**Benefits**
31+
- [ ] Improved code readability
32+
- [ ] Better performance
33+
- [ ] Reduced technical debt
34+
- [ ] Easier maintenance
35+
- [ ] Better test coverage
36+
- [ ] Other (please specify)
37+
38+
**Priority**
39+
- [ ] Low - Nice to have
40+
- [ ] Medium - Should be addressed soon
41+
- [ ] High - Urgent cleanup needed
42+
43+
**Additional context**
44+
Add any other context, screenshots, or examples about the cleanup task here.
45+
46+
**Related issues/PRs**
47+
Link any related issues or pull requests that are connected to this cleanup task.
Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
name: Feature request
3-
about: Suggest an idea for this project
4-
title: ''
5-
labels: ''
3+
about: Suggest an idea for libCacheSim
4+
title: '[FEATURE]: '
5+
labels: 'feature'
66
assignees: ''
77

88
---
@@ -13,8 +13,25 @@ A clear and concise description of what the problem is. Ex. I'm always frustrate
1313
**Describe the solution you'd like**
1414
A clear and concise description of what you want to happen.
1515

16+
**Feature category**
17+
Please check the relevant category:
18+
- [ ] New cache algorithm implementation
19+
- [ ] New eviction policy
20+
- [ ] New trace format support
21+
- [ ] Performance improvement
22+
- [ ] API enhancement
23+
- [ ] Documentation improvement
24+
- [ ] Build system improvement
25+
- [ ] Other (please specify)
26+
27+
**Use case**
28+
Describe the specific use case or scenario where this feature would be beneficial.
29+
1630
**Describe alternatives you've considered**
1731
A clear and concise description of any alternative solutions or features you've considered.
1832

33+
**Implementation considerations**
34+
If you have thoughts on how this could be implemented, please share them here.
35+
1936
**Additional context**
20-
Add any other context or screenshots about the feature request here.
37+
Add any other context, references to papers, or examples about the feature request here.

0 commit comments

Comments
 (0)