Skip to content
Merged
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
35 changes: 18 additions & 17 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
about: Create a report to help us improve libCacheSim
title: '[BUG]: '
labels: 'bug'
assignees: ''

---
Expand All @@ -12,27 +12,28 @@ 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 '....'
1. Build libCacheSim with: `bash scripts/debug.sh`
2. Run the command: `./_build_dbg/bin/cachesim ...`
3. Provide input parameters and trace file: `...`
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. Ubuntu 20.04, macOS 12.0, Windows 11]
- Compiler: [e.g. gcc 9.4.0, clang 12.0.0]
- libCacheSim version: [e.g. v0.1.0 or commit hash]
- Build type: [e.g. Debug, Release]

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

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

**Additional context**
Add any other context about the problem here.
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/cleanup_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: Cleanup
about: Report code cleanup, refactoring, or maintenance tasks
title: '[CLEANUP: '
labels: 'cleanup'
assignees: ''

---

**Area of cleanup**
Describe the area of the codebase that needs cleanup (e.g., specific modules, files, or directories).

**Type of cleanup**
- [ ] Code refactoring
- [ ] Remove deprecated code
- [ ] Update dependencies
- [ ] Improve documentation
- [ ] Code formatting/style consistency
- [ ] Remove unused code/variables
- [ ] Performance optimization
- [ ] Memory leak fixes
- [ ] Other (please specify)

**Current state**
Describe the current state of the code that needs cleanup. What makes it messy or problematic?

**Proposed improvements**
Describe what the cleaned-up code should look like. What improvements do you suggest?

**Benefits**
- [ ] Improved code readability
- [ ] Better performance
- [ ] Reduced technical debt
- [ ] Easier maintenance
- [ ] Better test coverage
- [ ] Other (please specify)

**Priority**
- [ ] Low - Nice to have
- [ ] Medium - Should be addressed soon
- [ ] High - Urgent cleanup needed

**Additional context**
Add any other context, screenshots, or examples about the cleanup task here.

**Related issues/PRs**
Link any related issues or pull requests that are connected to this cleanup task.
25 changes: 21 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
about: Suggest an idea for libCacheSim
title: '[FEATURE]: '
labels: 'feature'
assignees: ''

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

**Feature category**
Please check the relevant category:
- [ ] New cache algorithm implementation
- [ ] New eviction policy
- [ ] New trace format support
- [ ] Performance improvement
- [ ] API enhancement
- [ ] Documentation improvement
- [ ] Build system improvement
- [ ] Other (please specify)

**Use case**
Describe the specific use case or scenario where this feature would be beneficial.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Implementation considerations**
If you have thoughts on how this could be implemented, please share them here.

**Additional context**
Add any other context or screenshots about the feature request here.
Add any other context, references to papers, or examples about the feature request here.
Loading