Commit dc00825
authored
feat: Add comprehensive QA testing framework and multi-agent guidance system (#218)
* docs: add comprehensive PRD for deployment architecture refactor
- Complete design decisions with rationale
- 5 implementation phases with detailed tasks
- BDD acceptance criteria for all features
- Comprehensive testing strategy
- Risk analysis and mitigation
- Timeline with Gantt chart
- Success metrics and KPIs
Addresses packaging issues, version management, and testing gaps.
Establishes dual distribution (NuGet + GitHub releases).
Implements changelog-driven versioning with Ionide.KeepAChangelog.
* feat: add comprehensive QA testing framework and multi-agent guidance system
## QA Testing Framework
### Claude Code Skill
- Created .claude/skills/qa-tester/ with F# automation scripts
- smoke-test.fsx: Quick 2-minute validation (Build → Test → Package)
- regression-test.fsx: Full 10-15 minute regression suite
- validate-packages.fsx: NuGet package structure validation
- All scripts use Spectre.Console for rich terminal output
- Cross-platform (F# via dotnet fsi)
### Phase 1 Test Plan
- Comprehensive test plan for Phase 1 completion (PR #214)
- 19 test cases (11 critical, 7 high, 1 medium)
- Implementation analysis with deviations documented
- Test execution procedures and scripts
- docs/content/contributing/qa/phase-1-test-plan.md
## Cross-Agent Guidance System
### .agents/ Directory (New Pattern)
- Created .agents/ for specialized, domain-specific guidance
- .agents/qa-testing.md: Comprehensive QA guidance for all AI agents
- Pre-commit and PR verification checklists
- Test plan and bug report templates
- 5 testing playbooks (regression, feature, build, package, PR)
- BDD (Reqnroll) and unit testing (TUnit) guides
- Coverage requirements and best practices
- .agents/README.md: Navigation and contribution guidelines
### Multi-Agent Pointer Files
Created configuration files for all major AI coding assistants:
- .cursorrules: Cursor AI pointer and quick reference
- .github/copilot-instructions.md: GitHub Copilot instructions
- .windsurf/rules/morphir.md: Windsurf AI rules and workflows
- .windsurf/README.md: Windsurf configuration guide
- .idea/ai-assistant-rules.md: JetBrains AI Assistant rules
- .idea/README.md: JetBrains setup and integration guide
All pointer files:
- Direct to AGENTS.md as primary source
- Link to .agents/ for specialized topics
- Provide quick reference and tool-specific tips
- Follow tool-specific standards and conventions
### AGENTS.md Enhancements
- Added Quick Navigation section at top
- Links to .agents/, CLAUDE.md, docs/
- Visible immediately after header
- Added Section 18: Specialized Guidance
- Details available topics in .agents/
- Links to tool-specific guidance
- Lists future topics
- Added Section 19: Resources and References
- Primary documentation links
- Testing resources
- Morphir resources
- Standards and tools
## Benefits
### Discoverability
- All major AI tools (Cursor, Copilot, Windsurf, JetBrains AI, Claude Code) can discover guidance
- Clear navigation: Tool-specific → AGENTS.md → .agents/
- No orphaned documentation
### QA Automation
- F# test scripts provide consistent, repeatable testing
- Smoke test catches regressions quickly
- Regression suite validates complete functionality
- Package validation ensures correct structure
### Cross-Agent Compatibility
- Single source of truth (AGENTS.md)
- Specialized topics work with any AI agent
- Tool-specific optimizations when available
## Standards Compliance
- AGENTS.md Standard: Fully compliant (https://agents.md)
- Cursor: .cursorrules follows conventions
- GitHub Copilot: .github/copilot-instructions.md per GitHub docs
- Windsurf: .windsurf/rules/*.md per Windsurf docs
- JetBrains: Settings → AI Assistant → Rules per JetBrains docs
## Related Issues
- Closes #209 (Phase 1 verification and test plan)
- Filed #217 (Deferred helper classes from Phase 1)
🤖 Generated with [Claude Code](https://claude.com/claude-code)
* docs: add dotnet tool restore to setup instructions and F# script troubleshooting
## Setup Instructions Enhanced
### AGENTS.md Section 4
- Added First-time Setup subsection
- Documents dotnet tool restore, dotnet restore, dotnet husky install
- Updated Commands to reference both direct dotnet and ./build.sh commands
### README.md
- Added first-time setup command in Basic Commands section
- Shows dotnet tool restore before ./build.sh --target Restore
- Ensures tools are available before building
### F# Script Troubleshooting
- Added troubleshooting section to .claude/skills/qa-tester/README.md
- Documents 3 options for resolving package errors
- Special notes for Claude Code limitations
- Clarifies F# script NuGet package references work in most environments
## Rationale
F# scripts use NuGet package references (#r "nuget: Spectre.Console") which require
packages to be cached locally. Running 'dotnet tool restore' ensures tools like
Husky.Net and others are available, and 'dotnet restore' caches NuGet packages
for F# Interactive to use.
This is especially important for:
- First-time contributors setting up the repo
- CI/CD environments
- Claude Code skills that may have package installation limitations
Fixes potential issues where F# scripts fail with missing package errors.1 parent 331e327 commit dc00825
File tree
18 files changed
+6461
-7
lines changed- .agents
- .claude/skills/qa-tester
- .github
- .idea
- .windsurf
- rules
- docs/content/contributing
- design/prds
- qa
18 files changed
+6461
-7
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
0 commit comments