From c7f896b5cce3cb9992512fb03506904e06dfa77b Mon Sep 17 00:00:00 2001 From: Juncheng Yang Date: Sun, 22 Jun 2025 15:07:23 +0000 Subject: [PATCH 1/6] Update issue templates for bug reports and feature requests; add cleanup request template --- .github/ISSUE_TEMPLATE/bug_report.md | 37 +++++++++--------- .github/ISSUE_TEMPLATE/cleanup_request.md | 47 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 25 ++++++++++-- 3 files changed, 87 insertions(+), 22 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/cleanup_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea78..93579eac 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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: '' --- @@ -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: `bsah 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. +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/cleanup_request.md b/.github/ISSUE_TEMPLATE/cleanup_request.md new file mode 100644 index 00000000..4c6ff1e1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/cleanup_request.md @@ -0,0 +1,47 @@ +--- +name: Cleanup +about: Report code cleanup, refactoring, or maintenance tasks +title: '[Cleanup]: ' +labels: 'cleanup, maintenance' +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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7d..ff12460f 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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: 'enhancement' assignees: '' --- @@ -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. From 98af051be7e6f7bf4a3855d8a8e15050f7d3f8ee Mon Sep 17 00:00:00 2001 From: Percy Date: Sun, 22 Jun 2025 12:18:10 -0400 Subject: [PATCH 2/6] Update .github/ISSUE_TEMPLATE/bug_report.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 93579eac..298248e0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -12,7 +12,7 @@ A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: -1. Build libCacheSim with: `bsah scripts/debug.sh` +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 From 9c7dd82022be5262724882521f51d8510f0241a2 Mon Sep 17 00:00:00 2001 From: Juncheng Yang <1a1a11a@users.noreply.github.com> Date: Sun, 22 Jun 2025 12:43:23 -0400 Subject: [PATCH 3/6] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 298248e0..93b8398a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,7 +1,7 @@ --- name: Bug report about: Create a report to help us improve libCacheSim -title: '[BUG] ' +title: '[BUG]:' labels: 'bug' assignees: '' @@ -36,4 +36,4 @@ If applicable, provide: If applicable, add error messages, stack traces, or relevant log output. **Additional context** -Add any other context about the problem here. \ No newline at end of file +Add any other context about the problem here. From e986d315e2ca0b3055cc7666592368575ce81720 Mon Sep 17 00:00:00 2001 From: Juncheng Yang <1a1a11a@users.noreply.github.com> Date: Sun, 22 Jun 2025 12:43:56 -0400 Subject: [PATCH 4/6] Update cleanup_request.md --- .github/ISSUE_TEMPLATE/cleanup_request.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/cleanup_request.md b/.github/ISSUE_TEMPLATE/cleanup_request.md index 4c6ff1e1..728e3415 100644 --- a/.github/ISSUE_TEMPLATE/cleanup_request.md +++ b/.github/ISSUE_TEMPLATE/cleanup_request.md @@ -1,8 +1,8 @@ --- name: Cleanup about: Report code cleanup, refactoring, or maintenance tasks -title: '[Cleanup]: ' -labels: 'cleanup, maintenance' +title: '[CLEANUP: ' +labels: 'cleanup' assignees: '' --- From ff7c5338c302d9e4ef9dbd9b8bc558cd1f1393d6 Mon Sep 17 00:00:00 2001 From: Juncheng Yang <1a1a11a@users.noreply.github.com> Date: Sun, 22 Jun 2025 12:44:12 -0400 Subject: [PATCH 5/6] Update feature_request.md --- .github/ISSUE_TEMPLATE/feature_request.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index ff12460f..28cdcaf2 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,8 +1,8 @@ --- name: Feature request about: Suggest an idea for libCacheSim -title: '[FEATURE] ' -labels: 'enhancement' +title: '[FEATURE]: ' +labels: 'feature' assignees: '' --- From f61be95c6705231cca3040b8093364a83926c79c Mon Sep 17 00:00:00 2001 From: Juncheng Yang <1a1a11a@users.noreply.github.com> Date: Sun, 22 Jun 2025 12:44:31 -0400 Subject: [PATCH 6/6] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 93b8398a..2a83ebe6 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,7 +1,7 @@ --- name: Bug report about: Create a report to help us improve libCacheSim -title: '[BUG]:' +title: '[BUG]: ' labels: 'bug' assignees: ''