feat: create qa agent skill for detailed code review#834
Open
amaan-bhati wants to merge 1 commit intomainfrom
Open
feat: create qa agent skill for detailed code review#834amaan-bhati wants to merge 1 commit intomainfrom
amaan-bhati wants to merge 1 commit intomainfrom
Conversation
Signed-off-by: amaan-bhati <amaanbhati49@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new repo-specific Claude Code QA skill pack at .claude/skills/qa-agent/ to drive structured QA reviews (impact tracing + rule/checklist-based review) tailored to this Docusaurus docs repository.
Changes:
- Introduces a
/qa-agentorchestrator (SKILL.md) with argument parsing and a 3-subagent workflow (explore/impact/review) plus report generation. - Adds repo-tailored rule docs (framework/SEO/security/performance/content/TypeScript) and gate checklists (PR review, SEO, accessibility).
- Adds static context inputs (codebase map, hotspots, ignore list, known suppressions) and a QA report template.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
.claude/skills/qa-agent/SKILL.md |
Skill orchestrator: args, workflow, severity model, report pathing |
.claude/skills/qa-agent/agents/codebase-explorer.md |
Subagent spec for mapping repo structure/import relationships |
.claude/skills/qa-agent/agents/impact-tracer.md |
Subagent spec for tracing direct/indirect/config references |
.claude/skills/qa-agent/agents/qa-reviewer.md |
Subagent spec for applying rules/checklists and emitting findings |
.claude/skills/qa-agent/rules/framework.md |
Docusaurus-specific review rules and navigation/versioning expectations |
.claude/skills/qa-agent/rules/content.md |
Docs/content quality rules (links, alt text, frontmatter, examples) |
.claude/skills/qa-agent/rules/seo.md |
SEO-focused review rules for links, canonicals, structured data, redirects |
.claude/skills/qa-agent/rules/security.md |
Security review rules for secrets, scripts, redirects, and docs examples |
.claude/skills/qa-agent/rules/performance.md |
Frontend/build performance review rules for shared components/scripts |
.claude/skills/qa-agent/rules/typescript.md |
Conditional TypeScript rules for future TS additions / TS-heavy examples |
.claude/skills/qa-agent/checklists/pr-review.md |
Gate checklist for PR readiness (security, console logs, docs metadata, etc.) |
.claude/skills/qa-agent/checklists/accessibility.md |
Accessibility checklist for content and interactive UI changes |
.claude/skills/qa-agent/checklists/seo.md |
SEO checklist to ensure common regressions are explicitly checked |
.claude/skills/qa-agent/context/codebase-map.md |
Captured repo map (structure, routing, CI/CD, conventions, risk areas) |
.claude/skills/qa-agent/context/hotspots.md |
Hotspot file list intended for prioritized review modes |
.claude/skills/qa-agent/context/ignore.md |
Paths/patterns the QA workflow should skip by default |
.claude/skills/qa-agent/context/known-suppressions.md |
Known suppressions/deviations to reduce review false positives |
.claude/skills/qa-agent/templates/report.md |
Markdown template for the generated QA report |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| --- | ||
| name: qa-agent | ||
| description: "Run a full QA review of this codebase. Traces cross-file impact, checks framework best practices, security, performance, and accessibility. Use /qa-agent for full review, /qa-agent [filepath] for targeted review, /qa-agent --diff for changed files only, /qa-agent --hotspots for most-changed files only." | ||
| allowed-tools: Read, Grep, Glob, Bash |
Comment on lines
+44
to
+50
| Review `git diff HEAD --name-only`. | ||
|
|
||
| If that returns no files, fall back to the 10 most recently changed tracked files: | ||
|
|
||
| ```bash | ||
| git log --name-only --format="" -n 20 | awk 'NF' | awk '!seen[$0]++' | head -10 | ||
| ``` |
| @@ -0,0 +1,48 @@ | |||
| # Framework Rules | |||
|
|
|||
| Project classification: Docusaurus 3.9.2 docs site using `@docusaurus/preset-classic` in `docusaurus.config.js`, with docs mounted at the site root via `routeBasePath: "/"`. | |||
| - Project type: versioned documentation website for Keploy | ||
| - Primary framework: Docusaurus `3.9.2` from `package.json` | ||
| - Runtime stack: React `18.2.0`, plain JavaScript source, Tailwind-enabled styling, MDX docs | ||
| - Router strategy: Docusaurus docs plugin mounted at `/` via `routeBasePath: "/"` in `docusaurus.config.js` |
Comment on lines
+7
to
+8
| 1. All docs must include frontmatter with `id`, `title`, and `description`. | ||
| Follow the pattern used in `versioned_docs/version-4.0.0/running-keploy/public-api.md`. |
| A broken `#section` link in docs is a user-facing bug even if the page still builds. | ||
|
|
||
| 5. Frontmatter must include: | ||
| `title` required, `description` required, `tags` optional but encouraged. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
production-grade QA review skill bundle at
.claude/skills/qa-agent/for Claude Code workflows. The implementation is designed to support/qa-agentstyle review flows by packaging a single orchestrator prompt, three specialized subagent prompts, project-specific rulebooks, review checklists, generated codebase context, and a reusable reporting template.The goal is not just to add a generic review prompt, but to add a repo-aware QA system that understands how this codebase is actually built and where regressions are most likely to happen. In practice, that means the skill now reviews Docusaurus docs, versioned sidebars, shared components, theme overrides, SEO metadata, and browser scripts differently instead of treating the repo like a generic React app.
What Was Implemented
1. Main orchestrator
.claude/skills/qa-agent/SKILL.md--diff,--full, and--hotspotsqa-reports/YYYY-MM-DD-HH-MM.mdat runtimeWhy this exists:
How it was designed:
2. Specialized agent definitions
codebase-explorer.mdimpact-tracer.mdqa-reviewer.md3. Rules layer
framework.mdtypescript.mdsecurity.mdperformance.mdcontent.mdseo.md4. Checklists layer
.claude/skills/qa-agent/checklists/pr-review.md.claude/skills/qa-agent/checklists/accessibility.md.claude/skills/qa-agent/checklists/seo.md5. Context layer
.claude/skills/qa-agent/context/codebase-map.md.claude/skills/qa-agent/context/hotspots.md.claude/skills/qa-agent/context/known-suppressions.md.claude/skills/qa-agent/context/ignore.md6. Report template
.claude/skills/qa-agent/templates/report.mdWhat it does:
Why The Folder Structure Looks Like This
The structure under
.claude/skills/qa-agent/is intentionally layered:SKILL.mdagents/rules/checklists/context/templates/Validation Performed
.claude/skills/qa-agent/SKILL.mdfrontmatter is valid YAMLcontext/codebase-map.mdandcontext/hotspots.mdcontain real repo data[TODO]or[placeholder]markers remain in context filesqa-reports/, because the skill is designed to create it only when runSources And References
Local repo sources
package.jsondocusaurus.config.jssidebars.jssrc/theme/DocItem/index.jssrc/pages/index.jssrc/components/index.js.gitignore.vale.ini.github/workflows/main.yml.github/workflows/build_and_check.yml.github/workflows/vale-lint-action.ymlExternal references used to verify the implementation approach
Notes
.claude/skills/qa-agent/agents/is a project-local organization choice for this skill package.