From 5fbddac36b6b816880672e99aa6b3e20b57c9016 Mon Sep 17 00:00:00 2001 From: Basit Mustafa Date: Fri, 25 Jul 2025 15:13:30 -0700 Subject: [PATCH] Revert "chore(integrations): claude integration docs/gh templates" This reverts commit 5babf43b90e6684505ac257a576f9910c78274b4. --- .github/ISSUE_TEMPLATE/agent_improvement.md | 211 -------------------- .github/ISSUE_TEMPLATE/bug_report.md | 134 +++---------- .github/ISSUE_TEMPLATE/config.yml | 14 -- .github/ISSUE_TEMPLATE/documentation.md | 184 ----------------- .github/ISSUE_TEMPLATE/feature_request.md | 186 ++--------------- .github/ISSUE_TEMPLATE/question.md | 108 ---------- .github/pull_request_template.md | 123 ------------ README.md | 2 - 8 files changed, 36 insertions(+), 926 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/agent_improvement.md delete mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/documentation.md delete mode 100644 .github/ISSUE_TEMPLATE/question.md delete mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/agent_improvement.md b/.github/ISSUE_TEMPLATE/agent_improvement.md deleted file mode 100644 index f35c0173..00000000 --- a/.github/ISSUE_TEMPLATE/agent_improvement.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -name: ๐ŸŽญ Agent Improvement -about: Suggest improvements to specific BMAD Claude agents -title: '[AGENT] [Agent Name] - ' -labels: ['agent-improvement', 'enhancement'] -assignees: '' ---- - -# ๐ŸŽญ Agent Improvement - -## ๐Ÿ“Š Target Agent - -- [ ] ๐Ÿ“Š **Analyst (Mary)** - Market research, competitive analysis, project briefing -- [ ] ๐Ÿ—๏ธ **Architect (Winston)** - System design, technical architecture -- [ ] ๐Ÿ‘จโ€๐Ÿ’ป **Dev (James)** - Implementation, coding, technical development -- [ ] ๐Ÿ“‹ **PM (John)** - Project management, planning, coordination -- [ ] ๐Ÿ” **QA (Quinn)** - Quality assurance, testing, validation -- [ ] ๐ŸŽฏ **Scrum Master (Bob)** - Agile process management, team facilitation -- [ ] ๐Ÿ”„ **Cross-Agent** - Multi-agent workflows and collaboration - -## ๐ŸŽฏ Improvement Type - -- [ ] ๐Ÿง  **Persona Enhancement** - Improve agent character/personality -- [ ] ๐Ÿ“ **Prompt Optimization** - Better system prompts and instructions -- [ ] ๐Ÿ› ๏ธ **New Capabilities** - Add new commands or skills -- [ ] ๐Ÿ“š **BMAD Integration** - Better methodology adherence -- [ ] ๐Ÿค **Collaboration** - Improve cross-agent workflows -- [ ] ๐Ÿ’พ **Memory/Context** - Better context management -- [ ] ๐Ÿ“Š **Output Quality** - Improve response quality -- [ ] ๐ŸŽจ **User Experience** - Better interaction patterns - -## ๐Ÿ“‹ Current Behavior - -**What does the agent do now?** - -### Current Strengths - - -### Current Limitations - - -### Example Current Response -``` - -``` - -## โœจ Proposed Improvement - -**What should the agent do differently?** - -### Detailed Description - - -### Expected Benefits - - -### Example Improved Response -``` - -``` - -## ๐Ÿงช Testing Scenario - - -### Test Prompt -``` - -``` - -### Success Criteria - -- [ ] Criterion 1 -- [ ] Criterion 2 -- [ ] Criterion 3 - -### Evaluation Method -- [ ] Manual testing in Claude Code -- [ ] Comparison with previous responses -- [ ] User feedback collection -- [ ] Automated scoring (if applicable) - -## ๐ŸŽญ BMAD Methodology Alignment - - -### BMAD Integration -- [ ] Enhances existing BMAD workflow adherence -- [ ] Adds new BMAD artifact usage -- [ ] Improves BMAD template integration -- [ ] Better cross-agent BMAD coordination -- [ ] Maintains BMAD methodology integrity - -### Agent Role Consistency - -- [ ] Stays true to agent's primary BMAD function -- [ ] Enhances domain expertise appropriately -- [ ] Maintains professional persona -- [ ] Supports BMAD workflow patterns - -## ๐Ÿ“ˆ Impact Assessment - -### User Experience Impact -- [ ] ๐ŸŸข Significantly improves user experience -- [ ] ๐ŸŸก Moderately improves user experience -- [ ] ๐ŸŸ  Minor improvement -- [ ] ๐Ÿ”ด Minimal impact - -### Agent Performance Impact -- [ ] ๐ŸŸข Major improvement in agent capability -- [ ] ๐ŸŸก Moderate improvement -- [ ] ๐ŸŸ  Small improvement -- [ ] ๐Ÿ”ด Minimal improvement - -### Implementation Complexity -- [ ] ๐ŸŸข Simple - Prompt/template changes only -- [ ] ๐ŸŸก Medium - Some code changes required -- [ ] ๐ŸŸ  Complex - Significant changes needed -- [ ] ๐Ÿ”ด Major - Architectural changes required - -## ๐Ÿ”ง Implementation Details - -### Prompt Changes Required - - -### New Dependencies - -- [ ] New task files in bmad-core/tasks/ -- [ ] New templates in bmad-core/templates/ -- [ ] New data files in bmad-core/data/ -- [ ] Agent template modifications -- [ ] Build system changes - -### Tool/Command Changes -- [ ] New BMAD commands needed -- [ ] Existing command modifications -- [ ] New tool permissions required -- [ ] Memory/persistence changes - -## ๐Ÿ“Š Comparison Analysis - - -### Similar Functionality - - -### Best Practices - - -### Differentiation - - -## ๐Ÿ”— Related Work - -- Related to #(issue number) -- Inspired by #(issue number) -- Builds on #(issue number) - -### External References - -- BMAD methodology documentation -- Claude Code best practices -- Agent prompt engineering guides - -## ๐Ÿ“‹ Additional Context - -### User Feedback - - -### Research/Evidence - - -### Examples from Other Domains - - -## ๐Ÿค Implementation Plan - - -### Phase 1: Planning -- [ ] Finalize improvement specification -- [ ] Design prompt modifications -- [ ] Plan testing approach - -### Phase 2: Implementation -- [ ] Modify agent templates/prompts -- [ ] Add any new dependencies -- [ ] Update build system if needed - -### Phase 3: Testing -- [ ] Test with sample scenarios -- [ ] Validate BMAD integration -- [ ] Collect feedback - -### Phase 4: Refinement -- [ ] Iterate based on testing -- [ ] Document changes -- [ ] Update examples - -## ๐Ÿค Contribution - -- [ ] I can implement the prompt changes -- [ ] I can help with testing and validation -- [ ] I can provide additional use cases -- [ ] I can help with documentation -- [ ] I need guidance but want to contribute - ---- - -**Please ensure you've:** -- [ ] Clearly identified the target agent(s) -- [ ] Provided specific examples of current vs. improved behavior -- [ ] Considered BMAD methodology alignment -- [ ] Thought through implementation complexity -- [ ] Included testing criteria diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dc2fe60c..979457ee 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,120 +1,32 @@ --- -name: ๐Ÿ› Bug Report -about: Report a bug in the BMAD Claude integration -title: '[BUG] ' -labels: ['bug', 'needs-triage'] -assignees: '' +name: Bug report +about: Create a report to help us improve +title: "" +labels: "" +assignees: "" --- -# ๐Ÿ› Bug Report +**Describe the bug** +A clear and concise description of what the bug is. -## ๐Ÿ“‹ Summary - +**Steps to Reproduce** +What lead to the bug and can it be reliable recreated - if so with what steps. -## ๐ŸŽญ Affected Component - -- [ ] ๐Ÿ“Š Analyst Agent (Mary) -- [ ] ๐Ÿ—๏ธ Architect Agent (Winston) -- [ ] ๐Ÿ‘จโ€๐Ÿ’ป Dev Agent (James) -- [ ] ๐Ÿ“‹ PM Agent (John) -- [ ] ๐Ÿ” QA Agent (Quinn) -- [ ] ๐ŸŽฏ Scrum Master Agent (Bob) -- [ ] ๐Ÿ› ๏ธ Build System (`npm run build:claude`) -- [ ] ๐Ÿงช Testing Framework -- [ ] ๐Ÿ“š Documentation -- [ ] ๐Ÿ”„ Cross-agent workflows -- [ ] ๐Ÿ’พ Memory/persistence -- [ ] ๐Ÿ“ BMAD integration +**PR** +If you have an idea to fix and would like to contribute, please indicate here you are working on a fix, or link to a proposed PR to fix the issue. Please review the contribution.md - contributions are always welcome! -## ๐Ÿ”„ Steps to Reproduce - -1. Run `npm run build:claude` -2. Start Claude Code with `claude` -3. Execute command: '...' -4. See error +**Expected behavior** +A clear and concise description of what you expected to happen. -## โœ… Expected Behavior - +**Please be Specific if relevant** +Model(s) Used: +Agentic IDE Used: +WebSite Used: +Project Language: +BMad Method version: -## โŒ Actual Behavior - +**Screenshots or Links** +If applicable, add screenshots or links (if web sharable record) to help explain your problem. -## ๐Ÿ“ธ Screenshots/Output - -``` - -``` - -## ๐Ÿ–ฅ๏ธ Environment - - -### System Information -- **OS**: [e.g. macOS 14.6, Windows 11, Ubuntu 22.04] -- **Node.js Version**: [e.g. v20.5.0] -- **npm Version**: [e.g. 9.8.0] -- **Claude Code Version**: [run `claude --version`] - -### BMAD Integration Version -- **BMAD Method Version**: [check package.json version] -- **Integration Build**: [when did you last run `npm run build:claude`?] -- **Git Commit**: [run `git rev-parse HEAD`] - -### File State -- [ ] `.claude/agents/` directory exists -- [ ] All 6 agent files present (analyst, architect, dev, pm, qa, sm) -- [ ] `npm run validate` passes in integration/claude - -## ๐Ÿ”ง Configuration - - -### Agent Configuration -- **Custom modifications**: [Yes/No - describe any changes made] -- **Tool permissions**: [any custom tool configurations] -- **Memory settings**: [any custom memory configurations] - -### Build Configuration -- **Custom templates**: [any modifications to agent.mustache] -- **Custom BMAD data**: [any additions to bmad-core/data/] -- **Environment variables**: [any relevant env vars] - -## ๐Ÿงช Attempted Solutions - -- [ ] Rebuilt agents with `npm run build:claude` -- [ ] Cleared `.claude` directory and rebuilt -- [ ] Restarted Claude Code -- [ ] Checked for Claude Code updates -- [ ] Verified Node.js version compatibility -- [ ] Reviewed error logs - -## ๐Ÿ“‹ Additional Context - - -### Error Frequency -- [ ] Happens every time -- [ ] Happens sometimes -- [ ] Happened once -- [ ] Only in specific scenarios - -### Impact Level -- [ ] ๐Ÿ”ฅ Critical - Blocks all functionality -- [ ] ๐ŸŸ  High - Blocks major functionality -- [ ] ๐ŸŸก Medium - Workaround available -- [ ] ๐ŸŸข Low - Minor inconvenience - -### Workarounds - - -## ๐Ÿค Contribution - -- [ ] I'd like to work on fixing this issue -- [ ] I can provide additional testing -- [ ] I have ideas for the solution -- [ ] I need guidance on how to help - ---- - -**Please ensure you've:** -- [ ] Searched existing issues to avoid duplicates -- [ ] Provided all requested information -- [ ] Used a descriptive title -- [ ] Included steps to reproduce the issue +**Additional context** +Add any other context about the problem here. The more information you can provide, the easier it will be to suggest a fix or resolve diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index 4ca7238c..00000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1,14 +0,0 @@ -blank_issues_enabled: true -contact_links: - - name: ๐Ÿ’ฌ Community Discussion - url: https://discord.gg/gk8jAdXWmj - about: Join our Discord community for general questions, ideas, and collaboration - - name: ๐Ÿ“– BMAD Method Documentation - url: https://github.com/bmadcode/bmad-method - about: Original BMAD-Method documentation and core methodology - - name: ๐Ÿ”ง Claude Code Documentation - url: https://docs.anthropic.com/en/docs/claude-code/overview - about: Official Claude Code documentation and subagent guides - - name: ๐Ÿš€ Claude Code Download - url: https://claude.ai/code - about: Download and install Claude Code for your platform diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index bb6bfac9..00000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -name: ๐Ÿ“š Documentation -about: Request documentation improvements or report documentation issues -title: '[DOCS] ' -labels: ['documentation', 'good first issue'] -assignees: '' ---- - -# ๐Ÿ“š Documentation Issue - -## ๐Ÿ“‹ Documentation Type - -- [ ] ๐Ÿ“– **User Guide** - How to use the BMAD Claude integration -- [ ] ๐Ÿ”ง **Setup/Installation** - Getting started instructions -- [ ] ๐ŸŽญ **Agent Usage** - How to use specific agents effectively -- [ ] ๐Ÿงช **Testing Guide** - How to test and validate the integration -- [ ] ๐Ÿ› ๏ธ **Developer Docs** - Technical implementation details -- [ ] ๐Ÿ“ **API Reference** - Command and configuration reference -- [ ] ๐Ÿ”„ **Workflow Examples** - Real-world usage examples -- [ ] ๐Ÿ› **Troubleshooting** - Common issues and solutions -- [ ] ๐Ÿ“‹ **Contributing** - How to contribute to the project -- [ ] ๐Ÿ—๏ธ **Architecture** - Technical architecture documentation - -## ๐ŸŽฏ Issue Type - -- [ ] โŒ **Missing Documentation** - Something that should be documented isn't -- [ ] ๐Ÿ“ **Unclear Documentation** - Existing docs are confusing or incomplete -- [ ] ๐Ÿ”„ **Outdated Documentation** - Docs don't match current functionality -- [ ] ๐Ÿ› **Incorrect Documentation** - Docs contain errors or wrong information -- [ ] โœจ **Enhancement Request** - Suggestion for better documentation -- [ ] ๐Ÿ”— **Broken Links** - Links that don't work or go to wrong places -- [ ] ๐Ÿ“ฑ **Format/Structure** - Improve organization or presentation - -## ๐Ÿ“ Location - -**File(s) affected:** -- [ ] README.md (main) -- [ ] integration/claude/README.md -- [ ] integration/claude/TESTING.md -- [ ] integration/claude/complete-test-framework.md -- [ ] integration/claude/manual-test-guide.md -- [ ] docs/claude-integration.md -- [ ] CONTRIBUTING.md -- [ ] Other: _______________ - -**Section/area:** - - -## ๐Ÿ“‹ Current State - -**Current documentation:** - - -**What's wrong/missing:** - - -## โœจ Requested Improvement - -**Proposed content:** - - -### Specific Additions/Changes - - -### Target Audience - -- [ ] New users trying to get started -- [ ] Experienced users looking for advanced features -- [ ] Developers wanting to contribute -- [ ] Troubleshooting specific issues -- [ ] Integration with existing BMAD workflows - -## ๐ŸŽฏ Use Case - -**User scenario:** - - -**Current pain points:** - - -## ๐Ÿ“ Content Suggestions - - -### Structure - - -### Examples - - -### Code Samples -```bash -# Example commands that should be documented -``` - -### Screenshots/Diagrams - - -## ๐Ÿ”— Related Documentation - -- Similar documentation in: [link] -- Related to issue: #(number) -- Referenced in: [location] - -### External References - -- Claude Code official docs -- BMAD methodology guides -- Similar project documentation - -## ๐Ÿ“Š Priority/Impact - - -### Impact Level -- [ ] ๐Ÿ”ฅ **Critical** - Blocks users from basic functionality -- [ ] ๐ŸŸ  **High** - Significantly impacts user experience -- [ ] ๐ŸŸก **Medium** - Moderately helpful improvement -- [ ] ๐ŸŸข **Low** - Nice to have enhancement - -### User Frequency -- [ ] Daily use - core functionality -- [ ] Weekly use - common workflows -- [ ] Monthly use - occasional needs -- [ ] Rare use - edge cases - -### Complexity -- [ ] Simple addition/fix (minutes) -- [ ] Medium effort (hours) -- [ ] Complex documentation (days) -- [ ] Major restructuring needed - -## ๐ŸŽญ Agent-Specific Context - -**Relevant agents:** -- [ ] ๐Ÿ“Š Analyst documentation -- [ ] ๐Ÿ—๏ธ Architect documentation -- [ ] ๐Ÿ‘จโ€๐Ÿ’ป Dev documentation -- [ ] ๐Ÿ“‹ PM documentation -- [ ] ๐Ÿ” QA documentation -- [ ] ๐ŸŽฏ Scrum Master documentation -- [ ] ๐Ÿ”„ Cross-agent workflows - -**BMAD methodology context:** - - -## โœ… Acceptance Criteria - -- [ ] Information is accurate and up-to-date -- [ ] Examples work when followed step-by-step -- [ ] Language is clear and accessible -- [ ] Structure is logical and easy to navigate -- [ ] Covers all necessary use cases -- [ ] Includes troubleshooting for common issues - -## ๐Ÿค Contribution - -- [ ] I can write the documentation -- [ ] I can provide content/examples -- [ ] I can review drafts -- [ ] I can test the documented procedures -- [ ] I need help but want to contribute - -### Draft Content - - -## ๐Ÿ“‹ Additional Context - - -### User Feedback - - -### Common Questions - - -### Success Stories - - ---- - -**Please ensure you've:** -- [ ] Checked existing documentation to avoid duplicates -- [ ] Provided specific location information -- [ ] Included concrete suggestions for improvement -- [ ] Considered the target audience -- [ ] Specified the impact and priority level diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index a43c682c..9453b837 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,182 +1,22 @@ --- -name: โœจ Feature Request -about: Suggest an improvement or new feature for the BMAD Claude integration -title: '[FEATURE] ' -labels: ['enhancement', 'needs-discussion'] -assignees: '' +name: Feature request +about: Suggest an idea for this project +title: "" +labels: "" +assignees: "" --- -# โœจ Feature Request +**Did you discuss the idea first in Discord Server (#general-dev)** +Yes/No - Link to thread. If no, please after posting request also share the link in the channel so it can be easily discussed. -## ๐Ÿ“‹ Summary - +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -## ๐ŸŽฏ Component Area - -- [ ] ๐Ÿ“Š Analyst Agent capabilities -- [ ] ๐Ÿ—๏ธ Architect Agent capabilities -- [ ] ๐Ÿ‘จโ€๐Ÿ’ป Dev Agent capabilities -- [ ] ๐Ÿ“‹ PM Agent capabilities -- [ ] ๐Ÿ” QA Agent capabilities -- [ ] ๐ŸŽฏ Scrum Master Agent capabilities -- [ ] ๐Ÿ”„ Cross-agent collaboration -- [ ] ๐Ÿ› ๏ธ Build system improvements -- [ ] ๐Ÿงช Testing framework -- [ ] ๐Ÿ“š Documentation -- [ ] ๐Ÿ’พ Memory/persistence -- [ ] ๐ŸŽญ Agent personas/prompts -- [ ] ๐Ÿ“ BMAD methodology integration -- [ ] ๐Ÿ”ง Developer experience -- [ ] ๐Ÿš€ Performance optimization - -## ๐Ÿ’ก Problem Statement - -**Is your feature request related to a problem?** -A clear and concise description of what the problem is. Ex. I'm always frustrated when... - -## ๐ŸŽฏ Proposed Solution - -**Describe the solution you'd like:** +**Describe the solution you'd like** A clear and concise description of what you want to happen. -### Detailed Description - - -### User Experience - - -### Example Usage -```bash -# Example commands or usage -``` - -## ๐Ÿค” Alternatives Considered - -**Describe alternatives you've considered:** +**Describe alternatives you've considered** A clear and concise description of any alternative solutions or features you've considered. -## ๐ŸŽญ Agent Behavior Impact - - -### Prompt Changes -- [ ] Requires agent prompt modifications -- [ ] New commands or capabilities needed -- [ ] Changes to existing command behavior -- [ ] No prompt changes needed - -### BMAD Integration -- [ ] Enhances BMAD methodology adherence -- [ ] Adds new BMAD artifacts/templates -- [ ] Improves cross-BMAD-agent workflows -- [ ] Maintains existing BMAD compatibility - -### Expected Agent Improvements - - -## ๐Ÿ”ง Technical Considerations - -### Implementation Complexity -- [ ] ๐ŸŸข Simple - Template/config changes -- [ ] ๐ŸŸก Medium - Some code changes required -- [ ] ๐ŸŸ  Complex - Significant code changes -- [ ] ๐Ÿ”ด Major - Architectural changes needed - -### Dependencies - -- [ ] Claude Code platform updates -- [ ] New npm dependencies -- [ ] External API integrations -- [ ] BMAD core changes -- [ ] No new dependencies - -### Compatibility -- [ ] Backwards compatible -- [ ] Requires migration -- [ ] Breaking change -- [ ] Optional feature - -## ๐Ÿ“Š Use Cases - - -### Primary Use Case - - -### Secondary Use Cases - - -### User Stories -``` -As a [user type], I want [feature] so that [benefit]. -``` - -## ๐ŸŽฏ Success Criteria - -- [ ] Measurable improvement in agent performance -- [ ] Positive user feedback -- [ ] Increased adoption of specific workflows -- [ ] Better BMAD methodology integration -- [ ] Enhanced developer experience - -## ๐Ÿ“ˆ Priority/Impact - - -### Impact Level -- [ ] ๐Ÿ”ฅ High - Significantly improves core functionality -- [ ] ๐ŸŸ  Medium - Notable improvement to user experience -- [ ] ๐ŸŸก Low - Nice to have enhancement - -### User Demand -- [ ] Many users have requested this -- [ ] Few users have requested this -- [ ] I personally need this -- [ ] Identified gap during development - -### Effort Estimate -- [ ] Low effort (hours) -- [ ] Medium effort (days) -- [ ] High effort (weeks) -- [ ] Unknown effort - -## ๐Ÿ”— Related - -- Related to #(issue number) -- Depends on #(issue number) -- Blocks #(issue number) - -### External References - -- Claude Code documentation: [link] -- BMAD methodology reference: [link] -- Similar implementations: [link] - -## ๐Ÿ“‹ Additional Context - - -### Mockups/Examples - - -### Research - - -### Community Input - - -## ๐Ÿค Contribution - -- [ ] I can implement this feature -- [ ] I can help with design/planning -- [ ] I can provide testing -- [ ] I can contribute documentation -- [ ] I need help but want to contribute - -### Implementation Ideas - - ---- - -**Please ensure you've:** -- [ ] Searched existing issues and discussions -- [ ] Provided clear use cases and benefits -- [ ] Considered impact on existing functionality -- [ ] Thought about implementation complexity -- [ ] Used a descriptive title +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 743f2d9e..00000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -name: โ“ Question -about: Ask a question about the BMAD Claude integration -title: '[QUESTION] ' -labels: ['question', 'needs-triage'] -assignees: '' ---- - -# โ“ Question - -## ๐Ÿ“‹ Question Summary - - -## ๐ŸŽฏ Category - -- [ ] ๐Ÿš€ **Getting Started** - Installation, setup, first steps -- [ ] ๐ŸŽญ **Agent Usage** - How to use specific agents effectively -- [ ] ๐Ÿ”„ **Workflows** - BMAD methodology and cross-agent processes -- [ ] ๐Ÿ› ๏ธ **Technical** - Implementation details, troubleshooting -- [ ] ๐Ÿงช **Testing** - How to validate and test the integration -- [ ] ๐Ÿ“š **Documentation** - Where to find information -- [ ] ๐Ÿค **Contributing** - How to help improve the project -- [ ] ๐Ÿ”— **Integration** - Using with existing BMAD workflows -- [ ] ๐ŸŽฏ **Best Practices** - Optimal usage patterns -- [ ] ๐Ÿ› **Troubleshooting** - Solving specific issues - -## ๐Ÿ” Detailed Question - - -### Context - - -### What I'm Trying to Do - - -### What I've Tried - -- [ ] Read the README.md files -- [ ] Checked the documentation in docs/ -- [ ] Ran `npm run test:claude` -- [ ] Searched existing issues -- [ ] Asked in Discord community -- [ ] Consulted Claude Code documentation - -### Specific Examples - -```bash -# Commands you've run -``` - -``` -# Output or responses you've seen -``` - -## ๐Ÿ–ฅ๏ธ Environment (if relevant) - -- **OS**: [e.g. macOS, Windows, Linux] -- **Node.js Version**: [e.g. v20.5.0] -- **Claude Code Version**: [run `claude --version`] -- **BMAD Integration**: [when did you last build?] - -## ๐ŸŽญ Agent Context (if relevant) - -**Relevant agents:** -- [ ] ๐Ÿ“Š Analyst (Mary) -- [ ] ๐Ÿ—๏ธ Architect (Winston) -- [ ] ๐Ÿ‘จโ€๐Ÿ’ป Dev (James) -- [ ] ๐Ÿ“‹ PM (John) -- [ ] ๐Ÿ” QA (Quinn) -- [ ] ๐ŸŽฏ Scrum Master (Bob) - -**BMAD workflow context:** - - -## ๐Ÿ“š Additional Context - - -### Related Resources - - -### Expected Outcome - -- [ ] Step-by-step instructions -- [ ] Conceptual explanation -- [ ] Code examples -- [ ] Best practice recommendations -- [ ] Troubleshooting guidance -- [ ] Resource/documentation pointers - -### Urgency -- [ ] ๐Ÿ”ฅ Urgent - Blocking critical work -- [ ] ๐ŸŸ  Soon - Needed within days -- [ ] ๐ŸŸก Normal - Needed within weeks -- [ ] ๐ŸŸข Low - Just curious/exploring - -## ๐Ÿค Community Help - -- [ ] I'd be willing to help others with similar questions -- [ ] I can contribute to documentation based on the answer -- [ ] I'm interested in improving this area of the project - ---- - -**Before posting, please:** -- [ ] Search existing issues for similar questions -- [ ] Check the Discord community for recent discussions -- [ ] Review the documentation in the repository -- [ ] Provide enough context for others to help you diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index 785f8675..00000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,123 +0,0 @@ -# BMAD Claude Integration - Pull Request - -## ๐Ÿ“‹ Summary - - -## ๐ŸŽฏ Type of Change - -- [ ] ๐Ÿ› Bug fix (non-breaking change which fixes an issue) -- [ ] โœจ New feature (non-breaking change which adds functionality) -- [ ] ๐Ÿ’ฅ Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] ๐Ÿ“š Documentation only changes -- [ ] ๐Ÿ”ง Refactoring (no functional changes, no api changes) -- [ ] โšก Performance improvements -- [ ] ๐Ÿงช Test improvements -- [ ] ๐ŸŽญ Agent improvements (prompts, personas, capabilities) -- [ ] ๐Ÿ—๏ธ Build system changes -- [ ] ๐Ÿ”„ CI/CD changes - -## ๐ŸŽญ Agent Impact - -- [ ] ๐Ÿ“Š Analyst (Mary) -- [ ] ๐Ÿ—๏ธ Architect (Winston) -- [ ] ๐Ÿ‘จโ€๐Ÿ’ป Dev (James) -- [ ] ๐Ÿ“‹ PM (John) -- [ ] ๐Ÿ” QA (Quinn) -- [ ] ๐ŸŽฏ Scrum Master (Bob) -- [ ] ๐Ÿ› ๏ธ Build system / templates -- [ ] ๐Ÿ“ BMAD core integration - -## ๐Ÿงช Testing - - -### Automated Testing -- [ ] `npm run build:claude` passes -- [ ] `npm run test:claude` passes -- [ ] `npm run validate` passes (in integration/claude) -- [ ] All agent files generate without errors - -### Manual Testing -- [ ] Tested affected agents in Claude Code -- [ ] Verified agent behavior matches expectations -- [ ] Tested cross-agent workflows (if applicable) -- [ ] Validated BMAD methodology integration - -### Test Commands Used -```bash -# List the specific test commands you ran -``` - -### Test Results - - -## ๐Ÿ“ Checklist - - -### Code Quality -- [ ] My code follows the project's style guidelines -- [ ] I have performed a self-review of my own code -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] My changes generate no new warnings or errors - -### Documentation -- [ ] I have made corresponding changes to the documentation -- [ ] I have updated README.md if needed -- [ ] I have updated integration/claude/README.md if needed -- [ ] Any new features are documented - -### BMAD Integration -- [ ] Changes maintain BMAD methodology integrity -- [ ] Agent personas remain consistent with BMAD roles -- [ ] Template and task integrations work correctly -- [ ] Cross-agent collaboration still functions - -### Compatibility -- [ ] Changes are compatible with existing Claude Code installations -- [ ] Original BMAD structure remains unmodified (clean separation) -- [ ] No breaking changes to existing agent configurations - -## ๐Ÿ”— Related Issues - -Fixes #(issue number) -Closes #(issue number) -Related to #(issue number) - -## ๐Ÿ“ธ Screenshots - - -## ๐Ÿค” Additional Context - - -### Breaking Changes - - -### Migration Guide - - -### Performance Impact - - -## ๐Ÿ“‹ Reviewer Guidelines - - -### Focus Areas -- [ ] Agent prompt quality and BMAD integration -- [ ] Code architecture and maintainability -- [ ] Documentation completeness -- [ ] Test coverage and validation -- [ ] Compatibility and backwards compatibility - -### Testing Instructions - - -1. Build the agents: `npm run build:claude` -2. Run validation: `npm run test:claude` -3. Test specific agents: [provide specific test scenarios] -4. Verify [specific functionality] - ---- - -**By submitting this PR, I confirm that:** -- [ ] I have read and agree to the [Contributing Guidelines](CONTRIBUTING.md) -- [ ] This contribution is my own work or properly attributed -- [ ] I understand this will be released under the MIT license diff --git a/README.md b/README.md index d4b06606..2f116983 100644 --- a/README.md +++ b/README.md @@ -38,8 +38,6 @@ There are a few enhancements I have attempted to make to make the flow/DX of usi - Memory priming - Data sourcing helper -See [Claude Code Subagents Integration](docs/claude-integration.md) for more details. - ```bash # Generate Claude Code subagents npm run build:claude