mirror of
https://github.com/foambubble/foam.git
synced 2026-01-08 21:48:15 -05:00
* Added FOAM_CURRENT_DIR template variable * Added /research-issue Claude command * Added integration test to create note using FOAM_CURRENT_DIR * Updated documentation * fixed comment * Fail FOAM_CURRENT_DIR resolution if no editor nor workspace is open
1.9 KiB
1.9 KiB
Research Issue Command
Research a GitHub issue by analyzing the issue details and codebase to generate a comprehensive task analysis file.
Usage
/research-issue <issue-number>
Parameters
issue-number(required): The GitHub issue number to research
Description
This command performs comprehensive research on a GitHub issue by:
- Fetching Issue Details: Uses
gh issue viewto get issue title, description, labels, comments, and related information - Codebase Analysis: Searches the codebase for relevant files, patterns, and components mentioned in the issue
- Root Cause Analysis: Identifies possible technical causes based on the issue description and codebase findings
- Solution Planning: Proposes two solution approaches ranked by preference
- Documentation: Creates a structured task file in
.agent/tasks/<issue-id>-<sanitized-title>.md
If there is already a .agent/tasks/<issue-id>-<sanitized-title>.md file, use it for context and update it accordingly.
If at any time during these steps you need clarifying information from me, please ask.
Output Format
Creates a markdown file with:
- Issue summary and key details
- Research findings from codebase analysis
- Identified possible root causes
- Two ranked solution approaches with pros/cons
- Technical considerations and dependencies
Examples
/research-issue 1234
/research-issue 567
Implementation
The command will:
- Validate the issue number and check if it exists
- Fetch issue details using GitHub CLI
- Search codebase for relevant patterns, files, and components
- Analyze findings to identify root causes
- Generate structured markdown file with research results
- Save to
.agent/tasks/directory with standardized naming
Error Handling
- Invalid issue numbers
- GitHub CLI authentication issues
- Network connectivity problems
- File system write permissions