Skip to content

Commit 4d464da

Browse files
authored
Add issue template for documentation (#218)
* Add doc issue template * Fix cleanup issue template * Update documentation.md
1 parent 1103ab0 commit 4d464da

5 files changed

Lines changed: 47 additions & 4 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: Bug report
2+
name: 🐛 Bug report
33
about: Create a report to help us improve libCacheSim
44
title: '[BUG]: '
55
labels: 'bug'

.github/ISSUE_TEMPLATE/cleanup_request.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
name: Cleanup
2+
name: 🧹 Cleanup
33
about: Report code cleanup, refactoring, or maintenance tasks
4-
title: '[CLEANUP: '
4+
title: '[CLEANUP]: '
55
labels: 'cleanup'
66
assignees: ''
77

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Questions
4+
url: https://github.com/1a1a11a/libCacheSim/discussions
5+
about: Ask questions and discuss with other libCacheSim community members
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: 📚 Documentation
3+
about: Report an issue related to libCacheSim documentation
4+
title: '[DOC]: '
5+
labels: 'documentation'
6+
assignees: ''
7+
8+
---
9+
10+
**Documentation Issue**
11+
A clear and concise description of what content in the documentation is an issue.
12+
13+
**Suggested Improvement**
14+
Tell us how we could improve the documentation in this regard.
15+
16+
**Documentation Category**
17+
Please check the relevant category:
18+
- [ ] API documentation
19+
- [ ] Installation guide
20+
- [ ] Usage examples
21+
- [ ] Performance guide
22+
- [ ] Troubleshooting
23+
- [ ] README files
24+
- [ ] Code comments
25+
- [ ] Other (please specify)
26+
27+
**Current Documentation Location**
28+
Please specify where the problematic documentation is located (e.g., file path, URL, section name).
29+
30+
**Additional Context**
31+
Add any other context about the documentation issue here.
32+
33+
**Before submitting this issue**
34+
- [ ] I have searched for relevant issues in the repository
35+
- [ ] I have checked the existing documentation thoroughly
36+
- [ ] I have provided specific suggestions for improvement
37+
38+
Thanks for contributing to libCacheSim documentation! 🎉

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: Feature request
2+
name: 🚀 Feature request
33
about: Suggest an idea for libCacheSim
44
title: '[FEATURE]: '
55
labels: 'feature'

0 commit comments

Comments
 (0)