Skip to content

Commit 15c0813

Browse files
thedotmackclaude
andcommitted
docs: add bug report tool instructions to README and issue template
Add comprehensive documentation for the automated bug report generator: README.md: - New "Bug Reports" section with usage instructions - Plugin directory paths for all platforms (macOS/Linux/Windows) - Feature highlights and command options - Positioned between Troubleshooting and Contributing sections .github/ISSUE_TEMPLATE/bug_report.md: - Prominently feature automated bug report tool as recommended approach - Include platform-specific plugin directory paths - Add labels "bug, needs-triage" by default - Provide fallback manual bug report template - Document tool features and privacy options 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
1 parent f1da66e commit 15c0813

File tree

2 files changed

+90
-5
lines changed

2 files changed

+90
-5
lines changed
Lines changed: 59 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,68 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
3+
about: Use the automated bug report tool for best results
44
title: ''
5-
labels: ''
5+
labels: 'bug, needs-triage'
66
assignees: ''
77

88
---
99

10-
⏺ The worker logs are at:
10+
## ⚡ Quick Bug Report (Recommended)
1111

12-
~/.claude-mem/logs/worker-YYYY-MM-DD.log
12+
**Use the automated bug report generator** for comprehensive diagnostics:
1313

14-
For example: ~/.claude-mem/logs/worker-2025-12-14.log
14+
```bash
15+
# Navigate to the plugin directory
16+
cd ~/.claude/plugins/marketplaces/thedotmack
17+
18+
# Run the bug report tool
19+
npm run bug-report
20+
```
21+
22+
**Plugin Paths:**
23+
- **macOS/Linux**: `~/.claude/plugins/marketplaces/thedotmack`
24+
- **Windows**: `%USERPROFILE%\.claude\plugins\marketplaces\thedotmack`
25+
26+
**Features:**
27+
- 🌎 Auto-translates any language to English
28+
- 📊 Collects all diagnostics automatically
29+
- 🤖 AI-formatted professional issue
30+
- 🔒 Privacy-safe (paths sanitized, `--no-logs` option)
31+
- 🌐 Auto-opens GitHub with pre-filled issue
32+
33+
---
34+
35+
## 📝 Manual Bug Report
36+
37+
If you prefer to file manually or can't access the plugin directory:
38+
39+
### Bug Description
40+
A clear description of what the bug is.
41+
42+
### Steps to Reproduce
43+
1. Go to '...'
44+
2. Click on '...'
45+
3. See error
46+
47+
### Expected Behavior
48+
What you expected to happen.
49+
50+
### Environment
51+
- **Claude-mem version**:
52+
- **Claude Code version**:
53+
- **OS**:
54+
- **Platform**:
55+
56+
### Logs
57+
Worker logs are located at:
58+
- **Path**: `~/.claude-mem/logs/worker-YYYY-MM-DD.log`
59+
- **Example**: `~/.claude-mem/logs/worker-2025-12-14.log`
60+
61+
Please paste relevant log entries (last 50 lines or error messages):
62+
63+
```
64+
[Paste logs here]
65+
```
66+
67+
### Additional Context
68+
Any other context about the problem.

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -404,6 +404,37 @@ See [Troubleshooting Guide](https://docs.claude-mem.ai/troubleshooting) for comp
404404

405405
---
406406

407+
## Bug Reports
408+
409+
**Automated Bug Report Generator** - Create comprehensive bug reports with one command:
410+
411+
```bash
412+
# From the plugin directory
413+
cd ~/.claude/plugins/marketplaces/thedotmack
414+
npm run bug-report
415+
```
416+
417+
The bug report tool will:
418+
- 🌎 **Auto-translate** - Write in ANY language, automatically translates to English
419+
- 📊 **Collect diagnostics** - Gathers versions, platform info, worker status, logs, and configuration
420+
- 📝 **Interactive prompts** - Guides you through describing the issue with multiline support
421+
- 🤖 **AI formatting** - Uses Claude Agent SDK to generate professional GitHub issues
422+
- 🔒 **Privacy-safe** - Auto-sanitizes paths, optional `--no-logs` flag
423+
- 🌐 **Auto-submit** - Opens GitHub with pre-filled title and body
424+
425+
**Plugin Directory Paths:**
426+
- **macOS/Linux**: `~/.claude/plugins/marketplaces/thedotmack`
427+
- **Windows**: `%USERPROFILE%\.claude\plugins\marketplaces\thedotmack`
428+
429+
**Options:**
430+
```bash
431+
npm run bug-report --no-logs # Skip logs for privacy
432+
npm run bug-report --verbose # Show all diagnostics
433+
npm run bug-report --help # Show help
434+
```
435+
436+
---
437+
407438
## Contributing
408439

409440
Contributions are welcome! Please:

0 commit comments

Comments
 (0)