@event4u/agent-config 1.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.agent-src/README.md +64 -0
- package/.agent-src/commands/agent-handoff.md +64 -0
- package/.agent-src/commands/agent-status.md +83 -0
- package/.agent-src/commands/agents-audit.md +243 -0
- package/.agent-src/commands/agents-cleanup.md +169 -0
- package/.agent-src/commands/agents-prepare.md +137 -0
- package/.agent-src/commands/analyze-reference-repo.md +191 -0
- package/.agent-src/commands/bug-fix.md +181 -0
- package/.agent-src/commands/bug-investigate.md +175 -0
- package/.agent-src/commands/commit.md +121 -0
- package/.agent-src/commands/compress.md +177 -0
- package/.agent-src/commands/config-agent-settings.md +126 -0
- package/.agent-src/commands/context-create.md +167 -0
- package/.agent-src/commands/context-refactor.md +170 -0
- package/.agent-src/commands/copilot-agents-init.md +150 -0
- package/.agent-src/commands/copilot-agents-optimize.md +251 -0
- package/.agent-src/commands/create-pr-description.md +112 -0
- package/.agent-src/commands/create-pr.md +76 -0
- package/.agent-src/commands/do-and-judge.md +114 -0
- package/.agent-src/commands/do-in-steps.md +84 -0
- package/.agent-src/commands/e2e-heal.md +98 -0
- package/.agent-src/commands/e2e-plan.md +85 -0
- package/.agent-src/commands/estimate-ticket.md +80 -0
- package/.agent-src/commands/feature-dev.md +111 -0
- package/.agent-src/commands/feature-explore.md +180 -0
- package/.agent-src/commands/feature-plan.md +288 -0
- package/.agent-src/commands/feature-refactor.md +181 -0
- package/.agent-src/commands/feature-roadmap.md +184 -0
- package/.agent-src/commands/fix-ci.md +48 -0
- package/.agent-src/commands/fix-portability.md +97 -0
- package/.agent-src/commands/fix-pr-bot-comments.md +146 -0
- package/.agent-src/commands/fix-pr-comments.md +58 -0
- package/.agent-src/commands/fix-pr-developer-comments.md +152 -0
- package/.agent-src/commands/fix-references.md +94 -0
- package/.agent-src/commands/fix-seeder.md +146 -0
- package/.agent-src/commands/implement-ticket.md +133 -0
- package/.agent-src/commands/jira-ticket.md +71 -0
- package/.agent-src/commands/judge.md +86 -0
- package/.agent-src/commands/memory-add.md +130 -0
- package/.agent-src/commands/memory-full.md +97 -0
- package/.agent-src/commands/memory-promote.md +144 -0
- package/.agent-src/commands/mode.md +121 -0
- package/.agent-src/commands/module-create.md +132 -0
- package/.agent-src/commands/module-explore.md +157 -0
- package/.agent-src/commands/optimize-agents.md +139 -0
- package/.agent-src/commands/optimize-augmentignore.md +262 -0
- package/.agent-src/commands/optimize-rtk-filters.md +120 -0
- package/.agent-src/commands/optimize-skills.md +121 -0
- package/.agent-src/commands/override-create.md +97 -0
- package/.agent-src/commands/override-manage.md +96 -0
- package/.agent-src/commands/package-reset.md +154 -0
- package/.agent-src/commands/package-test.md +154 -0
- package/.agent-src/commands/prepare-for-review.md +91 -0
- package/.agent-src/commands/project-analyze.md +300 -0
- package/.agent-src/commands/project-health.md +95 -0
- package/.agent-src/commands/propose-memory.md +108 -0
- package/.agent-src/commands/quality-fix.md +106 -0
- package/.agent-src/commands/refine-ticket.md +81 -0
- package/.agent-src/commands/review-changes.md +130 -0
- package/.agent-src/commands/review-routing.md +111 -0
- package/.agent-src/commands/roadmap-create.md +110 -0
- package/.agent-src/commands/roadmap-execute.md +68 -0
- package/.agent-src/commands/rule-compliance-audit.md +139 -0
- package/.agent-src/commands/tests-create.md +73 -0
- package/.agent-src/commands/tests-execute.md +58 -0
- package/.agent-src/commands/threat-model.md +115 -0
- package/.agent-src/commands/update-form-request-messages.md +189 -0
- package/.agent-src/commands/upstream-contribute.md +171 -0
- package/.agent-src/contexts/augment-infrastructure.md +181 -0
- package/.agent-src/contexts/documentation-hierarchy.md +142 -0
- package/.agent-src/contexts/model-recommendations.md +142 -0
- package/.agent-src/contexts/override-system.md +187 -0
- package/.agent-src/contexts/skills-and-commands.md +154 -0
- package/.agent-src/contexts/subagent-configuration.md +62 -0
- package/.agent-src/guidelines/agent-infra/agent-interaction-and-decision-quality.md +110 -0
- package/.agent-src/guidelines/agent-infra/break-glass-usage.md +113 -0
- package/.agent-src/guidelines/agent-infra/developer-judgment.md +82 -0
- package/.agent-src/guidelines/agent-infra/engineering-memory-data-format.md +117 -0
- package/.agent-src/guidelines/agent-infra/layered-settings.md +158 -0
- package/.agent-src/guidelines/agent-infra/memory-access.md +121 -0
- package/.agent-src/guidelines/agent-infra/naming.md +69 -0
- package/.agent-src/guidelines/agent-infra/output-patterns.md +117 -0
- package/.agent-src/guidelines/agent-infra/review-routing-data-format.md +144 -0
- package/.agent-src/guidelines/agent-infra/role-contracts.md +211 -0
- package/.agent-src/guidelines/agent-infra/role-mode-router.md +89 -0
- package/.agent-src/guidelines/agent-infra/runtime-layer.md +89 -0
- package/.agent-src/guidelines/agent-infra/self-improvement-pipeline.md +135 -0
- package/.agent-src/guidelines/agent-infra/size-and-scope.md +189 -0
- package/.agent-src/guidelines/agent-infra/tool-integration.md +73 -0
- package/.agent-src/guidelines/docs/readme-size-and-splitting.md +153 -0
- package/.agent-src/guidelines/e2e/playwright.md +363 -0
- package/.agent-src/guidelines/php/api-design.md +115 -0
- package/.agent-src/guidelines/php/artisan-commands.md +81 -0
- package/.agent-src/guidelines/php/blade-ui.md +78 -0
- package/.agent-src/guidelines/php/controllers.md +90 -0
- package/.agent-src/guidelines/php/database.md +111 -0
- package/.agent-src/guidelines/php/eloquent.md +208 -0
- package/.agent-src/guidelines/php/flux.md +80 -0
- package/.agent-src/guidelines/php/general.md +191 -0
- package/.agent-src/guidelines/php/git.md +96 -0
- package/.agent-src/guidelines/php/jobs.md +111 -0
- package/.agent-src/guidelines/php/livewire.md +71 -0
- package/.agent-src/guidelines/php/logging.md +79 -0
- package/.agent-src/guidelines/php/naming.md +89 -0
- package/.agent-src/guidelines/php/patterns/dependency-injection.md +57 -0
- package/.agent-src/guidelines/php/patterns/dtos.md +199 -0
- package/.agent-src/guidelines/php/patterns/events.md +67 -0
- package/.agent-src/guidelines/php/patterns/factory.md +53 -0
- package/.agent-src/guidelines/php/patterns/pipelines.md +66 -0
- package/.agent-src/guidelines/php/patterns/policies.md +66 -0
- package/.agent-src/guidelines/php/patterns/repositories.md +122 -0
- package/.agent-src/guidelines/php/patterns/service-layer.md +64 -0
- package/.agent-src/guidelines/php/patterns/strategy.md +69 -0
- package/.agent-src/guidelines/php/patterns.md +28 -0
- package/.agent-src/guidelines/php/performance.md +92 -0
- package/.agent-src/guidelines/php/resources.md +100 -0
- package/.agent-src/guidelines/php/security.md +110 -0
- package/.agent-src/guidelines/php/sql.md +97 -0
- package/.agent-src/guidelines/php/validations.md +119 -0
- package/.agent-src/guidelines/php/websocket.md +100 -0
- package/.agent-src/personas/README.md +104 -0
- package/.agent-src/personas/ai-agent.md +77 -0
- package/.agent-src/personas/critical-challenger.md +73 -0
- package/.agent-src/personas/developer.md +73 -0
- package/.agent-src/personas/product-owner.md +78 -0
- package/.agent-src/personas/qa.md +67 -0
- package/.agent-src/personas/senior-engineer.md +77 -0
- package/.agent-src/personas/stakeholder.md +78 -0
- package/.agent-src/rules/agent-docs.md +61 -0
- package/.agent-src/rules/analysis-skill-routing.md +48 -0
- package/.agent-src/rules/architecture.md +62 -0
- package/.agent-src/rules/artifact-drafting-protocol.md +73 -0
- package/.agent-src/rules/ask-when-uncertain.md +52 -0
- package/.agent-src/rules/augment-portability.md +38 -0
- package/.agent-src/rules/augment-source-of-truth.md +128 -0
- package/.agent-src/rules/capture-learnings.md +89 -0
- package/.agent-src/rules/cli-output-handling.md +94 -0
- package/.agent-src/rules/commit-conventions.md +64 -0
- package/.agent-src/rules/context-hygiene.md +90 -0
- package/.agent-src/rules/docker-commands.md +55 -0
- package/.agent-src/rules/docs-sync.md +79 -0
- package/.agent-src/rules/downstream-changes.md +70 -0
- package/.agent-src/rules/e2e-testing.md +53 -0
- package/.agent-src/rules/guidelines.md +90 -0
- package/.agent-src/rules/improve-before-implement.md +94 -0
- package/.agent-src/rules/language-and-tone.md +104 -0
- package/.agent-src/rules/laravel-translations.md +48 -0
- package/.agent-src/rules/markdown-safe-codeblocks.md +18 -0
- package/.agent-src/rules/minimal-safe-diff.md +87 -0
- package/.agent-src/rules/missing-tool-handling.md +62 -0
- package/.agent-src/rules/model-recommendation.md +70 -0
- package/.agent-src/rules/package-ci-checks.md +80 -0
- package/.agent-src/rules/php-coding.md +63 -0
- package/.agent-src/rules/preservation-guard.md +29 -0
- package/.agent-src/rules/review-routing-awareness.md +125 -0
- package/.agent-src/rules/reviewer-awareness.md +92 -0
- package/.agent-src/rules/roadmap-progress-sync.md +56 -0
- package/.agent-src/rules/role-mode-adherence.md +54 -0
- package/.agent-src/rules/rule-type-governance.md +46 -0
- package/.agent-src/rules/runtime-safety.md +42 -0
- package/.agent-src/rules/scope-control.md +40 -0
- package/.agent-src/rules/security-sensitive-stop.md +77 -0
- package/.agent-src/rules/size-enforcement.md +29 -0
- package/.agent-src/rules/skill-improvement-trigger.md +58 -0
- package/.agent-src/rules/skill-quality.md +110 -0
- package/.agent-src/rules/slash-commands.md +30 -0
- package/.agent-src/rules/think-before-action.md +91 -0
- package/.agent-src/rules/token-efficiency.md +99 -0
- package/.agent-src/rules/tool-safety.md +36 -0
- package/.agent-src/rules/upstream-proposal.md +76 -0
- package/.agent-src/rules/user-interaction.md +79 -0
- package/.agent-src/rules/verify-before-complete.md +120 -0
- package/.agent-src/scripts/scan-seeder-violations.php +145 -0
- package/.agent-src/scripts/update_roadmap_progress.py +244 -0
- package/.agent-src/skills/adversarial-review/SKILL.md +149 -0
- package/.agent-src/skills/agent-docs-writing/SKILL.md +234 -0
- package/.agent-src/skills/analysis-autonomous-mode/SKILL.md +197 -0
- package/.agent-src/skills/analysis-skill-router/SKILL.md +134 -0
- package/.agent-src/skills/api-design/SKILL.md +104 -0
- package/.agent-src/skills/api-endpoint/SKILL.md +185 -0
- package/.agent-src/skills/api-testing/SKILL.md +206 -0
- package/.agent-src/skills/artisan-commands/SKILL.md +78 -0
- package/.agent-src/skills/authz-review/SKILL.md +171 -0
- package/.agent-src/skills/aws-infrastructure/SKILL.md +152 -0
- package/.agent-src/skills/blade-ui/SKILL.md +75 -0
- package/.agent-src/skills/blast-radius-analyzer/SKILL.md +185 -0
- package/.agent-src/skills/bug-analyzer/SKILL.md +256 -0
- package/.agent-src/skills/check-refs/SKILL.md +72 -0
- package/.agent-src/skills/code-refactoring/SKILL.md +200 -0
- package/.agent-src/skills/code-review/SKILL.md +214 -0
- package/.agent-src/skills/command-routing/SKILL.md +96 -0
- package/.agent-src/skills/command-writing/SKILL.md +143 -0
- package/.agent-src/skills/composer-packages/SKILL.md +172 -0
- package/.agent-src/skills/context-authoring/SKILL.md +157 -0
- package/.agent-src/skills/context-document/SKILL.md +153 -0
- package/.agent-src/skills/conventional-commits-writing/SKILL.md +70 -0
- package/.agent-src/skills/copilot-agents-optimization/SKILL.md +220 -0
- package/.agent-src/skills/copilot-config/SKILL.md +203 -0
- package/.agent-src/skills/dashboard-design/SKILL.md +116 -0
- package/.agent-src/skills/data-flow-mapper/SKILL.md +160 -0
- package/.agent-src/skills/database/SKILL.md +91 -0
- package/.agent-src/skills/dependency-upgrade/SKILL.md +204 -0
- package/.agent-src/skills/description-assist/SKILL.md +169 -0
- package/.agent-src/skills/design-review/SKILL.md +228 -0
- package/.agent-src/skills/devcontainer/SKILL.md +121 -0
- package/.agent-src/skills/developer-like-execution/SKILL.md +276 -0
- package/.agent-src/skills/docker/SKILL.md +245 -0
- package/.agent-src/skills/dto-creator/SKILL.md +117 -0
- package/.agent-src/skills/eloquent/SKILL.md +92 -0
- package/.agent-src/skills/eloquent/evals/last-run.json +99 -0
- package/.agent-src/skills/eloquent/evals/triggers.json +16 -0
- package/.agent-src/skills/estimate-ticket/SKILL.md +186 -0
- package/.agent-src/skills/estimate-ticket/evals/output-schema.yml +20 -0
- package/.agent-src/skills/estimate-ticket/evals/triggers.json +18 -0
- package/.agent-src/skills/fe-design/SKILL.md +223 -0
- package/.agent-src/skills/feature-planning/SKILL.md +226 -0
- package/.agent-src/skills/file-editor/SKILL.md +129 -0
- package/.agent-src/skills/finishing-a-development-branch/SKILL.md +200 -0
- package/.agent-src/skills/flux/SKILL.md +64 -0
- package/.agent-src/skills/git-workflow/SKILL.md +102 -0
- package/.agent-src/skills/github-ci/SKILL.md +122 -0
- package/.agent-src/skills/grafana/SKILL.md +168 -0
- package/.agent-src/skills/guideline-writing/SKILL.md +147 -0
- package/.agent-src/skills/jira-integration/SKILL.md +182 -0
- package/.agent-src/skills/jobs-events/SKILL.md +87 -0
- package/.agent-src/skills/judge-bug-hunter/SKILL.md +157 -0
- package/.agent-src/skills/judge-code-quality/SKILL.md +158 -0
- package/.agent-src/skills/judge-security-auditor/SKILL.md +167 -0
- package/.agent-src/skills/judge-test-coverage/SKILL.md +154 -0
- package/.agent-src/skills/laravel/SKILL.md +195 -0
- package/.agent-src/skills/laravel-horizon/SKILL.md +169 -0
- package/.agent-src/skills/laravel-mail/SKILL.md +193 -0
- package/.agent-src/skills/laravel-middleware/SKILL.md +185 -0
- package/.agent-src/skills/laravel-notifications/SKILL.md +168 -0
- package/.agent-src/skills/laravel-pennant/SKILL.md +188 -0
- package/.agent-src/skills/laravel-pulse/SKILL.md +160 -0
- package/.agent-src/skills/laravel-reverb/SKILL.md +205 -0
- package/.agent-src/skills/laravel-scheduling/SKILL.md +167 -0
- package/.agent-src/skills/laravel-validation/SKILL.md +71 -0
- package/.agent-src/skills/learning-to-rule-or-skill/SKILL.md +249 -0
- package/.agent-src/skills/lint-skills/SKILL.md +72 -0
- package/.agent-src/skills/livewire/SKILL.md +79 -0
- package/.agent-src/skills/logging-monitoring/SKILL.md +100 -0
- package/.agent-src/skills/mcp/SKILL.md +193 -0
- package/.agent-src/skills/merge-conflicts/SKILL.md +158 -0
- package/.agent-src/skills/migration-creator/SKILL.md +160 -0
- package/.agent-src/skills/module-management/SKILL.md +154 -0
- package/.agent-src/skills/multi-tenancy/SKILL.md +129 -0
- package/.agent-src/skills/openapi/SKILL.md +154 -0
- package/.agent-src/skills/override-management/SKILL.md +186 -0
- package/.agent-src/skills/performance/SKILL.md +69 -0
- package/.agent-src/skills/performance-analysis/SKILL.md +118 -0
- package/.agent-src/skills/pest-testing/SKILL.md +321 -0
- package/.agent-src/skills/php-coder/SKILL.md +78 -0
- package/.agent-src/skills/php-coder/evals/triggers.json +16 -0
- package/.agent-src/skills/php-debugging/SKILL.md +184 -0
- package/.agent-src/skills/php-service/SKILL.md +96 -0
- package/.agent-src/skills/playwright-testing/SKILL.md +244 -0
- package/.agent-src/skills/project-analysis-core/SKILL.md +138 -0
- package/.agent-src/skills/project-analysis-hypothesis-driven/SKILL.md +130 -0
- package/.agent-src/skills/project-analysis-laravel/SKILL.md +119 -0
- package/.agent-src/skills/project-analysis-nextjs/SKILL.md +123 -0
- package/.agent-src/skills/project-analysis-node-express/SKILL.md +111 -0
- package/.agent-src/skills/project-analysis-react/SKILL.md +119 -0
- package/.agent-src/skills/project-analysis-symfony/SKILL.md +111 -0
- package/.agent-src/skills/project-analysis-zend-laminas/SKILL.md +108 -0
- package/.agent-src/skills/project-analyzer/SKILL.md +341 -0
- package/.agent-src/skills/project-docs/SKILL.md +137 -0
- package/.agent-src/skills/quality-tools/SKILL.md +411 -0
- package/.agent-src/skills/readme-reviewer/SKILL.md +187 -0
- package/.agent-src/skills/readme-writing/SKILL.md +142 -0
- package/.agent-src/skills/readme-writing-package/SKILL.md +185 -0
- package/.agent-src/skills/receiving-code-review/SKILL.md +190 -0
- package/.agent-src/skills/refine-ticket/SKILL.md +310 -0
- package/.agent-src/skills/refine-ticket/detection-map.yml +124 -0
- package/.agent-src/skills/refine-ticket/evals/output-schema.yml +16 -0
- package/.agent-src/skills/refine-ticket/evals/triggers.json +16 -0
- package/.agent-src/skills/requesting-code-review/SKILL.md +199 -0
- package/.agent-src/skills/review-routing/SKILL.md +195 -0
- package/.agent-src/skills/roadmap-management/SKILL.md +303 -0
- package/.agent-src/skills/rtk-output-filtering/SKILL.md +184 -0
- package/.agent-src/skills/rule-writing/SKILL.md +148 -0
- package/.agent-src/skills/security/SKILL.md +79 -0
- package/.agent-src/skills/security-audit/SKILL.md +123 -0
- package/.agent-src/skills/sentry-integration/SKILL.md +170 -0
- package/.agent-src/skills/sequential-thinking/SKILL.md +158 -0
- package/.agent-src/skills/skill-improvement-pipeline/SKILL.md +155 -0
- package/.agent-src/skills/skill-management/SKILL.md +121 -0
- package/.agent-src/skills/skill-reviewer/SKILL.md +218 -0
- package/.agent-src/skills/skill-writing/SKILL.md +291 -0
- package/.agent-src/skills/skill-writing/evals/triggers.json +16 -0
- package/.agent-src/skills/sql-writing/SKILL.md +74 -0
- package/.agent-src/skills/subagent-orchestration/SKILL.md +190 -0
- package/.agent-src/skills/systematic-debugging/SKILL.md +244 -0
- package/.agent-src/skills/technical-specification/SKILL.md +185 -0
- package/.agent-src/skills/terraform/SKILL.md +137 -0
- package/.agent-src/skills/terragrunt/SKILL.md +217 -0
- package/.agent-src/skills/test-driven-development/SKILL.md +252 -0
- package/.agent-src/skills/test-performance/SKILL.md +172 -0
- package/.agent-src/skills/threat-modeling/SKILL.md +189 -0
- package/.agent-src/skills/traefik/SKILL.md +319 -0
- package/.agent-src/skills/universal-project-analysis/SKILL.md +179 -0
- package/.agent-src/skills/upstream-contribute/SKILL.md +255 -0
- package/.agent-src/skills/using-git-worktrees/SKILL.md +148 -0
- package/.agent-src/skills/validate-feature-fit/SKILL.md +113 -0
- package/.agent-src/skills/verify-before-complete/SKILL.md +188 -0
- package/.agent-src/skills/websocket/SKILL.md +75 -0
- package/.agent-src/templates/AGENTS.md +146 -0
- package/.agent-src/templates/agent-settings.md +256 -0
- package/.agent-src/templates/agents/.gitattributes.fragment +16 -0
- package/.agent-src/templates/agents/agent-project-settings.example.yml +138 -0
- package/.agent-src/templates/agents/memory/architecture-decisions.example.yml +95 -0
- package/.agent-src/templates/agents/memory/domain-invariants.example.yml +80 -0
- package/.agent-src/templates/agents/memory/historical-patterns.example.yml +82 -0
- package/.agent-src/templates/agents/memory/incident-learnings.example.yml +113 -0
- package/.agent-src/templates/agents/memory/ownership.example.yml +75 -0
- package/.agent-src/templates/agents/memory/product-rules.example.yml +87 -0
- package/.agent-src/templates/agents/proposal.example.md +143 -0
- package/.agent-src/templates/command.md +84 -0
- package/.agent-src/templates/contexts/auth-model.md +59 -0
- package/.agent-src/templates/contexts/data-sensitivity.md +60 -0
- package/.agent-src/templates/contexts/deployment-order.md +72 -0
- package/.agent-src/templates/contexts/observability.md +64 -0
- package/.agent-src/templates/contexts/tenant-boundaries.md +68 -0
- package/.agent-src/templates/contexts.md +116 -0
- package/.agent-src/templates/copilot-instructions.md +115 -0
- package/.agent-src/templates/features.md +125 -0
- package/.agent-src/templates/github-workflows/memory-hygiene.yml +133 -0
- package/.agent-src/templates/github-workflows/pr-risk-review.yml +123 -0
- package/.agent-src/templates/github-workflows/proposal-drift.yml +118 -0
- package/.agent-src/templates/overrides/command.md +24 -0
- package/.agent-src/templates/overrides/guideline.md +21 -0
- package/.agent-src/templates/overrides/rule.md +19 -0
- package/.agent-src/templates/overrides/skill.md +24 -0
- package/.agent-src/templates/overrides/template.md +21 -0
- package/.agent-src/templates/persona.md +99 -0
- package/.agent-src/templates/roadmaps.md +109 -0
- package/.agent-src/templates/scripts/README.md +195 -0
- package/.agent-src/templates/scripts/check_memory.py +283 -0
- package/.agent-src/templates/scripts/check_memory_proposal.py +180 -0
- package/.agent-src/templates/scripts/historical-bug-patterns.example.yml +84 -0
- package/.agent-src/templates/scripts/implement_ticket/__init__.py +57 -0
- package/.agent-src/templates/scripts/implement_ticket/__main__.py +9 -0
- package/.agent-src/templates/scripts/implement_ticket/cli.py +171 -0
- package/.agent-src/templates/scripts/implement_ticket/delivery_state.py +130 -0
- package/.agent-src/templates/scripts/implement_ticket/dispatcher.py +134 -0
- package/.agent-src/templates/scripts/implement_ticket/persona_policy.py +85 -0
- package/.agent-src/templates/scripts/implement_ticket/steps/__init__.py +49 -0
- package/.agent-src/templates/scripts/implement_ticket/steps/analyze.py +98 -0
- package/.agent-src/templates/scripts/implement_ticket/steps/implement.py +145 -0
- package/.agent-src/templates/scripts/implement_ticket/steps/memory.py +136 -0
- package/.agent-src/templates/scripts/implement_ticket/steps/plan.py +175 -0
- package/.agent-src/templates/scripts/implement_ticket/steps/refine.py +140 -0
- package/.agent-src/templates/scripts/implement_ticket/steps/report.py +195 -0
- package/.agent-src/templates/scripts/implement_ticket/steps/test.py +180 -0
- package/.agent-src/templates/scripts/implement_ticket/steps/verify.py +170 -0
- package/.agent-src/templates/scripts/memory_hash.py +75 -0
- package/.agent-src/templates/scripts/memory_lookup.py +216 -0
- package/.agent-src/templates/scripts/memory_report.py +184 -0
- package/.agent-src/templates/scripts/memory_signal.py +167 -0
- package/.agent-src/templates/scripts/memory_status.py +156 -0
- package/.agent-src/templates/scripts/ownership-map.example.yml +87 -0
- package/.agent-src/templates/scripts/pr-risk-config.example.yml +76 -0
- package/.agent-src/templates/scripts/pr_review_routing.py +340 -0
- package/.agent-src/templates/scripts/pr_risk_review.py +211 -0
- package/.agent-src/templates/skill.md +136 -0
- package/.augment-plugin/marketplace.json +32 -0
- package/.augment-plugin/plugin.json +21 -0
- package/.claude-plugin/marketplace.json +119 -0
- package/AGENTS.md +121 -0
- package/CHANGELOG.md +279 -0
- package/CONTRIBUTING.md +176 -0
- package/LICENSE +21 -0
- package/README.md +357 -0
- package/bin/install.php +38 -0
- package/composer.json +29 -0
- package/config/agent-settings.template.yml +96 -0
- package/config/profiles/balanced.ini +10 -0
- package/config/profiles/full.ini +10 -0
- package/config/profiles/minimal.ini +10 -0
- package/docs/architecture.md +144 -0
- package/docs/customization.md +88 -0
- package/docs/development.md +171 -0
- package/docs/getting-started.md +130 -0
- package/docs/github-topics.md +84 -0
- package/docs/installation.md +376 -0
- package/docs/mcp.md +133 -0
- package/docs/quality.md +98 -0
- package/docs/skills-catalog.md +136 -0
- package/docs/troubleshooting.md +167 -0
- package/llms.txt +130 -0
- package/package.json +31 -0
- package/scripts/audit_skill_descriptions.py +168 -0
- package/scripts/check_compression.py +221 -0
- package/scripts/check_memory.py +341 -0
- package/scripts/check_memory_proposal.py +180 -0
- package/scripts/check_portability.py +320 -0
- package/scripts/check_proposal.py +269 -0
- package/scripts/check_references.py +400 -0
- package/scripts/ci_summary.py +131 -0
- package/scripts/compress.py +671 -0
- package/scripts/compress.sh +18 -0
- package/scripts/first-run.sh +109 -0
- package/scripts/generate_catalog.py +116 -0
- package/scripts/install +151 -0
- package/scripts/install-hooks.sh +29 -0
- package/scripts/install.py +487 -0
- package/scripts/install.sh +637 -0
- package/scripts/install_anthropic_key.sh +101 -0
- package/scripts/inventory_frontmatter.py +164 -0
- package/scripts/lint_marketplace.py +142 -0
- package/scripts/lint_regression.py +232 -0
- package/scripts/mcp_render.py +159 -0
- package/scripts/measure_patterns.py +376 -0
- package/scripts/memory_hash.py +75 -0
- package/scripts/memory_lookup.py +441 -0
- package/scripts/memory_report.py +336 -0
- package/scripts/memory_signal.py +210 -0
- package/scripts/memory_status.py +195 -0
- package/scripts/postinstall.sh +60 -0
- package/scripts/readme_linter.py +580 -0
- package/scripts/refine_ticket_detect.py +623 -0
- package/scripts/requirements-evals.txt +7 -0
- package/scripts/runtime_dispatcher.py +265 -0
- package/scripts/runtime_handler.py +148 -0
- package/scripts/runtime_registry.py +166 -0
- package/scripts/schemas/command.schema.json +32 -0
- package/scripts/schemas/persona.schema.json +42 -0
- package/scripts/schemas/rule.schema.json +28 -0
- package/scripts/schemas/skill.schema.json +73 -0
- package/scripts/setup.sh +230 -0
- package/scripts/setup_eval_venv.sh +58 -0
- package/scripts/skill_linter.py +2175 -0
- package/scripts/skill_trigger_eval.py +651 -0
- package/scripts/tool_registry.py +146 -0
- package/scripts/tools/__init__.py +1 -0
- package/scripts/tools/adapter_errors.py +63 -0
- package/scripts/tools/base_adapter.py +91 -0
- package/scripts/tools/github_adapter.py +128 -0
- package/scripts/tools/jira_adapter.py +115 -0
- package/scripts/update_counts.py +147 -0
- package/scripts/validate_frontmatter.py +424 -0
- package/templates/consumer-settings/README.md +46 -0
- package/templates/consumer-settings/augment-settings.json +12 -0
- package/templates/consumer-settings/claude-settings.json +9 -0
- package/templates/consumer-settings/copilot-settings.json +14 -0
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: readme-reviewer
|
|
3
|
+
description: "Use when reviewing a README for accuracy, usability, and alignment with the actual repository. Detects invented content, broken setup steps, and structural issues."
|
|
4
|
+
source: package
|
|
5
|
+
execution:
|
|
6
|
+
type: assisted
|
|
7
|
+
handler: internal
|
|
8
|
+
allowed_tools: []
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# readme-reviewer
|
|
12
|
+
|
|
13
|
+
## When to use
|
|
14
|
+
|
|
15
|
+
- Reviewing a newly created or rewritten README
|
|
16
|
+
- Validating a README matches the actual repository
|
|
17
|
+
- Auditing README quality across repos
|
|
18
|
+
- Checking for hallucinated setup, commands, or features
|
|
19
|
+
|
|
20
|
+
Do NOT use for:
|
|
21
|
+
|
|
22
|
+
- Grammar or formatting proofreading only
|
|
23
|
+
- Writing a README from scratch → use `readme-writing` or `readme-writing-package`
|
|
24
|
+
|
|
25
|
+
## Goal
|
|
26
|
+
|
|
27
|
+
Ensure README is correct (no invented content), aligned with the repo,
|
|
28
|
+
useful for the audience, with a strong quickstart path.
|
|
29
|
+
|
|
30
|
+
## Core principles
|
|
31
|
+
|
|
32
|
+
- Evidence over assumption — verify every claim against the repo
|
|
33
|
+
- Commands must exist — check `Taskfile.yml`, `Makefile`, `package.json scripts`
|
|
34
|
+
- Examples must match real APIs — compare against source code
|
|
35
|
+
- Quickstart quality matters more than completeness
|
|
36
|
+
- A clean-looking README can still be technically wrong
|
|
37
|
+
|
|
38
|
+
## Procedure
|
|
39
|
+
|
|
40
|
+
### 1. Identify README type and audience
|
|
41
|
+
|
|
42
|
+
Determine repo type (package, app, CLI, internal, framework) and audience
|
|
43
|
+
(consumers, contributors, team). Check if structure matches type.
|
|
44
|
+
|
|
45
|
+
### 2. Cross-check against repository
|
|
46
|
+
|
|
47
|
+
Inspect truth-defining files:
|
|
48
|
+
|
|
49
|
+
- `package.json` / `composer.json` — name, scripts, dependencies
|
|
50
|
+
- `Dockerfile` / `docker-compose.yml` — runtime setup
|
|
51
|
+
- `Taskfile.yml` / `Makefile` — available commands
|
|
52
|
+
- CI workflows — what gets tested
|
|
53
|
+
- Source entrypoints — actual public API
|
|
54
|
+
- Config files, tests, existing docs
|
|
55
|
+
|
|
56
|
+
Verify: install steps exist, commands work, features implemented, dependencies real.
|
|
57
|
+
|
|
58
|
+
### 3. Validate installation and setup
|
|
59
|
+
|
|
60
|
+
Check:
|
|
61
|
+
|
|
62
|
+
- Install command correct and complete
|
|
63
|
+
- Required post-install steps documented
|
|
64
|
+
- No hidden setup assumptions
|
|
65
|
+
- Environment/config requirements listed
|
|
66
|
+
|
|
67
|
+
Flag: missing steps, incorrect steps, implied-but-unwritten steps.
|
|
68
|
+
|
|
69
|
+
### 4. Validate usage examples
|
|
70
|
+
|
|
71
|
+
Check:
|
|
72
|
+
|
|
73
|
+
- First example minimal and realistic
|
|
74
|
+
- Example matches actual API (verify against source)
|
|
75
|
+
- Example doesn't rely on undocumented setup
|
|
76
|
+
- Example not overly complex or abstract
|
|
77
|
+
|
|
78
|
+
Flag: pseudo-code, oversized examples, API mismatches.
|
|
79
|
+
|
|
80
|
+
### 5. Validate compatibility and requirements
|
|
81
|
+
|
|
82
|
+
Check:
|
|
83
|
+
|
|
84
|
+
- Runtime versions stated (PHP, Node, etc.)
|
|
85
|
+
- Framework compatibility explicit
|
|
86
|
+
- Dependencies declared
|
|
87
|
+
|
|
88
|
+
Flag: missing compatibility, vague claims ("works with most versions"),
|
|
89
|
+
unconfirmed broad support.
|
|
90
|
+
|
|
91
|
+
### 6. Evaluate structure and clarity
|
|
92
|
+
|
|
93
|
+
Check:
|
|
94
|
+
|
|
95
|
+
- Strong first screen (what + why + quickstart before scroll)
|
|
96
|
+
- Logical section order for repo type
|
|
97
|
+
- No unnecessary sections (padded boilerplate)
|
|
98
|
+
- No missing critical sections
|
|
99
|
+
|
|
100
|
+
Common issues: architecture before installation, no quickstart, buried
|
|
101
|
+
usage, generic template sections.
|
|
102
|
+
|
|
103
|
+
### 7. Detect hallucinations
|
|
104
|
+
|
|
105
|
+
Search for:
|
|
106
|
+
|
|
107
|
+
- Commands not in repo
|
|
108
|
+
- Features not implemented
|
|
109
|
+
- Setup steps not supported by scripts/configs
|
|
110
|
+
- Assumptions about environment or tools
|
|
111
|
+
|
|
112
|
+
Classify each finding:
|
|
113
|
+
|
|
114
|
+
- **Confirmed incorrect** — verifiably wrong
|
|
115
|
+
- **Likely incorrect** — no evidence found, needs verification
|
|
116
|
+
- **Unclear** — cannot confirm or deny, needs human input
|
|
117
|
+
|
|
118
|
+
### 8. Check scope, size, and splitting
|
|
119
|
+
|
|
120
|
+
- README not overloaded with deep technical detail
|
|
121
|
+
- Complex content belongs in `/docs`, not README
|
|
122
|
+
- Important onboarding info not missing due to over-compression
|
|
123
|
+
|
|
124
|
+
Size checks:
|
|
125
|
+
|
|
126
|
+
- **< 150 lines** — healthy
|
|
127
|
+
- **150–300 lines** — expect a Table of Contents; flag if missing
|
|
128
|
+
- **300–500 lines** — flag as overloaded; deep content should be in `/docs/`
|
|
129
|
+
- **> 500 lines** — flag as broken entry point; hard split required
|
|
130
|
+
|
|
131
|
+
Structure checks:
|
|
132
|
+
|
|
133
|
+
- ToC present if > 150 lines or > 6 top-level (`##`) sections
|
|
134
|
+
- Multi-platform install (> 5 variants) uses a table with deep links, not stacked blocks
|
|
135
|
+
- `<details>` used only for secondary, bulky content — never for install, first example, or requirements
|
|
136
|
+
- No duplication between README and `/docs/` (drifts over time)
|
|
137
|
+
- Each `/docs/` file linked from README is self-contained (not just a fragment)
|
|
138
|
+
|
|
139
|
+
→ See `guidelines/docs/readme-size-and-splitting.md` for full thresholds,
|
|
140
|
+
splitting strategies, anti-patterns.
|
|
141
|
+
|
|
142
|
+
## Output format
|
|
143
|
+
|
|
144
|
+
### 1. Summary
|
|
145
|
+
|
|
146
|
+
| Field | Value |
|
|
147
|
+
|---|---|
|
|
148
|
+
| Repo type | {type} |
|
|
149
|
+
| Audience | {audience} |
|
|
150
|
+
| Overall | {short assessment} |
|
|
151
|
+
|
|
152
|
+
### 2. Findings
|
|
153
|
+
|
|
154
|
+
| # | Severity | Section | Issue | Fix |
|
|
155
|
+
|---|---|---|---|---|
|
|
156
|
+
| 1 | ❌ Critical | Install | Command `X` does not exist | Replace with `Y` |
|
|
157
|
+
| 2 | ⚠️ Major | Usage | Example uses deprecated API | Update to current API |
|
|
158
|
+
| 3 | ℹ️ Minor | Structure | Requirements buried below usage | Move above install |
|
|
159
|
+
|
|
160
|
+
Severity levels:
|
|
161
|
+
|
|
162
|
+
- **❌ Critical** — breaks onboarding or factually incorrect
|
|
163
|
+
- **⚠️ Major** — confusing, incomplete, or misleading
|
|
164
|
+
- **ℹ️ Minor** — clarity, formatting, structure
|
|
165
|
+
|
|
166
|
+
### 3. Confidence
|
|
167
|
+
|
|
168
|
+
- What is confirmed correct
|
|
169
|
+
- What needs human verification
|
|
170
|
+
- What is unclear due to missing context
|
|
171
|
+
|
|
172
|
+
## Gotcha
|
|
173
|
+
|
|
174
|
+
- Model trusts the README instead of verifying against the repo
|
|
175
|
+
- Model may miss subtle mismatches between examples and real APIs
|
|
176
|
+
- Model focuses on wording/style instead of correctness
|
|
177
|
+
- Well-formatted README with wrong commands worse than ugly but correct
|
|
178
|
+
- Model accepts "looks reasonable" compatibility without checking CI matrix
|
|
179
|
+
|
|
180
|
+
## Do NOT
|
|
181
|
+
|
|
182
|
+
- Do NOT assume README is correct without checking the repo
|
|
183
|
+
- Do NOT ignore missing or broken setup steps
|
|
184
|
+
- Do NOT accept vague compatibility statements as valid
|
|
185
|
+
- Do NOT focus only on wording while missing structural/correctness issues
|
|
186
|
+
- Do NOT overlook mismatches between examples and actual source code
|
|
187
|
+
- Do NOT soften findings — state issues clearly with severity
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: readme-writing
|
|
3
|
+
description: "Use when creating, rewriting, or significantly improving a README based on the actual repository structure, commands, and intended audience."
|
|
4
|
+
source: package
|
|
5
|
+
execution:
|
|
6
|
+
type: assisted
|
|
7
|
+
handler: internal
|
|
8
|
+
allowed_tools: []
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# readme-writing
|
|
12
|
+
|
|
13
|
+
## When to use
|
|
14
|
+
|
|
15
|
+
- Creating a new README for an **application, CLI tool, internal tool, template, or framework**
|
|
16
|
+
- Rewriting an outdated or weak README
|
|
17
|
+
- Improving after major repo changes (new tooling, restructure)
|
|
18
|
+
|
|
19
|
+
Do NOT use for:
|
|
20
|
+
|
|
21
|
+
- **Packages/libraries** → use `readme-writing-package` instead
|
|
22
|
+
- Minor typos, single-section updates, reference docs in separate files
|
|
23
|
+
|
|
24
|
+
## Goal
|
|
25
|
+
|
|
26
|
+
Accurate, evidence-based, scannable README for the intended audience.
|
|
27
|
+
Reflects the real repository — not assumptions.
|
|
28
|
+
|
|
29
|
+
## Core principles
|
|
30
|
+
|
|
31
|
+
- Analyze first, write second — inspect repo before writing
|
|
32
|
+
- Evidence-based — every command, step, feature must exist in repo
|
|
33
|
+
- Strong quickstart over exhaustive noise — get started in 30 seconds
|
|
34
|
+
- Right scope — overview in README, deep content in dedicated docs
|
|
35
|
+
- Match repo type — package README ≠ app ≠ CLI tool ≠ framework
|
|
36
|
+
|
|
37
|
+
## Procedure
|
|
38
|
+
|
|
39
|
+
### 1. Identify README type and audience
|
|
40
|
+
|
|
41
|
+
| Type | Audience | Priority |
|
|
42
|
+
|---|---|---|
|
|
43
|
+
| **Library/Package** | Developers consuming it | Install → Usage → API |
|
|
44
|
+
| **Application** | Team / contributors | Setup → Dev workflow → Architecture |
|
|
45
|
+
| **CLI tool** | End users | Install → Commands → Examples |
|
|
46
|
+
| **Template/Starter** | Bootstrappers | What you get → Quickstart → Customize |
|
|
47
|
+
| **Internal tool** | Team members | Purpose → Setup → Common tasks |
|
|
48
|
+
| **Agent/Framework** | AI tools + maintainers | What it is → Install → Architecture → Extend |
|
|
49
|
+
|
|
50
|
+
### 2. Inspect the repository
|
|
51
|
+
|
|
52
|
+
Read truth-defining files:
|
|
53
|
+
|
|
54
|
+
- `README.md` (existing), `package.json`, `composer.json`
|
|
55
|
+
- `Dockerfile`, `docker-compose.yml`
|
|
56
|
+
- `Taskfile.yml`, `Makefile`
|
|
57
|
+
- CI workflows, config files, `docs/`, `agents/`
|
|
58
|
+
|
|
59
|
+
Extract: purpose, install path, commands, requirements, workflows, testing, contribution flow.
|
|
60
|
+
|
|
61
|
+
### 3. Choose sections
|
|
62
|
+
|
|
63
|
+
Only include sections that provide value:
|
|
64
|
+
|
|
65
|
+
1. **Title + one-line summary** — always
|
|
66
|
+
2. **Why / what problem** — if not obvious from name
|
|
67
|
+
3. **Key features** — if more than trivial
|
|
68
|
+
4. **Requirements** — only if non-obvious
|
|
69
|
+
5. **Installation / setup** — always
|
|
70
|
+
6. **Usage / quickstart** — always (most important)
|
|
71
|
+
7. **Configuration** — if applicable
|
|
72
|
+
8. **Development workflow** — if accepts contributions
|
|
73
|
+
9. **Testing / quality** — if tooling exists
|
|
74
|
+
10. **Project structure** — if non-trivial
|
|
75
|
+
11. **Contributing** — if open/team project
|
|
76
|
+
12. **License** — if applicable
|
|
77
|
+
|
|
78
|
+
Skip empty or near-empty sections entirely.
|
|
79
|
+
|
|
80
|
+
### 4. Write evidence-based content
|
|
81
|
+
|
|
82
|
+
- Only document commands that exist in the repo
|
|
83
|
+
- Only describe setup steps supported by scripts/configs
|
|
84
|
+
- Only claim features confirmed by code or docs
|
|
85
|
+
- Unclear? Inspect more or ask — never invent
|
|
86
|
+
|
|
87
|
+
Formatting: tables for comparisons, code blocks for commands (copy-pasteable),
|
|
88
|
+
short paragraphs (max 3 sentences), directory trees for structure.
|
|
89
|
+
|
|
90
|
+
### 5. Optimize for first screen
|
|
91
|
+
|
|
92
|
+
Reader must answer within 10 seconds: What is this? Why? How to start?
|
|
93
|
+
|
|
94
|
+
First screen (before scroll): title, summary, install or quickstart.
|
|
95
|
+
|
|
96
|
+
### 6. Size and structure
|
|
97
|
+
|
|
98
|
+
Keep README scannable. Past ~150 lines: add Table of Contents. Past ~300
|
|
99
|
+
lines: split deep content to `/docs/` or `references/`. Use `<details>`
|
|
100
|
+
only for secondary, bulky content — never for install, first example, or
|
|
101
|
+
requirements.
|
|
102
|
+
|
|
103
|
+
→ See `guidelines/docs/readme-size-and-splitting.md` for thresholds,
|
|
104
|
+
splitting strategies (reference-split, deep-link tables, collapsibles),
|
|
105
|
+
multi-audience handling, anti-patterns.
|
|
106
|
+
|
|
107
|
+
### 7. Validate
|
|
108
|
+
|
|
109
|
+
- [ ] Every command exists in repo (`Taskfile.yml`, `Makefile`, `package.json`, etc.)
|
|
110
|
+
- [ ] Setup steps are reproducible
|
|
111
|
+
- [ ] No invented features or capabilities
|
|
112
|
+
- [ ] First screen answers: what, why, how-to-start
|
|
113
|
+
- [ ] No dead sections (heading with 1-2 trivial sentences)
|
|
114
|
+
- [ ] Deep content in dedicated docs, not crammed in README
|
|
115
|
+
- [ ] Size below "overloaded" threshold, or splitting in place (see size guideline)
|
|
116
|
+
- [ ] ToC present if > 150 lines or > 6 top-level sections
|
|
117
|
+
- [ ] All file paths and references are valid
|
|
118
|
+
|
|
119
|
+
## Output format
|
|
120
|
+
|
|
121
|
+
1. Full README draft
|
|
122
|
+
2. Short note: detected repo type + audience
|
|
123
|
+
3. Uncertainties or assumptions needing confirmation
|
|
124
|
+
|
|
125
|
+
## Gotcha
|
|
126
|
+
|
|
127
|
+
- Model writes generic boilerplate instead of repo-specific docs
|
|
128
|
+
- Model includes commands/steps that don't exist in the repo
|
|
129
|
+
- Model over-documents, burying the quickstart under walls of text
|
|
130
|
+
- Existing README structure can mislead — don't preserve weak structure blindly
|
|
131
|
+
- Package READMEs need install/usage focus, not internal dev workflow
|
|
132
|
+
- Model forgets to validate commands against `Taskfile.yml` / `Makefile` / `package.json`
|
|
133
|
+
|
|
134
|
+
## Do NOT
|
|
135
|
+
|
|
136
|
+
- Do NOT invent features, setup steps, or commands not in the repo
|
|
137
|
+
- Do NOT copy generic templates without adapting to the project
|
|
138
|
+
- Do NOT overload with deep reference material — link to docs
|
|
139
|
+
- Do NOT write for "everyone" — choose a real audience
|
|
140
|
+
- Do NOT skip repository inspection before writing
|
|
141
|
+
- Do NOT preserve weak structure just because it exists
|
|
142
|
+
- Do NOT add marketing language ("blazing fast", "revolutionary")
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: readme-writing-package
|
|
3
|
+
description: "Use when creating or rewriting a README for a reusable package or library. Focus on installability, minimal usage example, compatibility, and developer onboarding."
|
|
4
|
+
source: package
|
|
5
|
+
execution:
|
|
6
|
+
type: assisted
|
|
7
|
+
handler: internal
|
|
8
|
+
allowed_tools: []
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# readme-writing-package
|
|
12
|
+
|
|
13
|
+
## When to use
|
|
14
|
+
|
|
15
|
+
- Creating a README for a package, library, SDK, or framework extension
|
|
16
|
+
- Rewriting after major changes (new API, version bump, new registry)
|
|
17
|
+
- Improving a weak package README (missing install, no example, no compatibility)
|
|
18
|
+
- Documenting for Packagist, npm, or internal registries
|
|
19
|
+
|
|
20
|
+
Do NOT use for:
|
|
21
|
+
|
|
22
|
+
- Full applications, CLI tools, internal team repos → use `readme-writing`
|
|
23
|
+
- Minor typos, single-section updates, deep reference docs in `/docs`
|
|
24
|
+
|
|
25
|
+
## Goal
|
|
26
|
+
|
|
27
|
+
Package README that makes adoption easy. Developer knows within 30 seconds:
|
|
28
|
+
what it does, whether it fits their stack, how to install, how to use.
|
|
29
|
+
|
|
30
|
+
## Core principles
|
|
31
|
+
|
|
32
|
+
- User adoption over internal architecture — consumer first, maintainer second
|
|
33
|
+
- Install + first example = most important sections
|
|
34
|
+
- Compatibility must be explicit — don't imply broad support without evidence
|
|
35
|
+
- First example: real, minimal, verified — no pseudo-code
|
|
36
|
+
- README = onboarding, /docs = reference
|
|
37
|
+
|
|
38
|
+
## Procedure
|
|
39
|
+
|
|
40
|
+
### 1. Identify package type and audience
|
|
41
|
+
|
|
42
|
+
| Type | Audience | README focus |
|
|
43
|
+
|---|---|---|
|
|
44
|
+
| **Library** | Any developer | Install → Usage → API surface |
|
|
45
|
+
| **Framework extension** | Framework users | Requirements → Install → Register → Use |
|
|
46
|
+
| **Plugin** | Plugin host users | Compatibility → Install → Config → Use |
|
|
47
|
+
| **SDK** | API consumers | Auth → Install → First request → Response handling |
|
|
48
|
+
| **Internal shared package** | Team members | Purpose → Install → Integration → Dev workflow |
|
|
49
|
+
|
|
50
|
+
### 2. Inspect package truth sources
|
|
51
|
+
|
|
52
|
+
- `composer.json` / `package.json` — name, description, requirements, scripts
|
|
53
|
+
- Source entrypoints — public API, main classes/functions
|
|
54
|
+
- Config files — publishable configs, defaults
|
|
55
|
+
- CI workflows — supported versions matrix
|
|
56
|
+
- Tests — actual API usage patterns
|
|
57
|
+
- `CHANGELOG.md` / releases — current state, breaking changes
|
|
58
|
+
- Examples directory if present
|
|
59
|
+
|
|
60
|
+
Extract: name, purpose, install command, runtime requirements, supported
|
|
61
|
+
versions, public API, setup steps, test/lint commands.
|
|
62
|
+
|
|
63
|
+
### 3. Choose sections
|
|
64
|
+
|
|
65
|
+
Priority order for packages:
|
|
66
|
+
|
|
67
|
+
1. **Title + one-line summary** — always
|
|
68
|
+
2. **Why / what problem** — if not obvious from name
|
|
69
|
+
3. **Requirements / compatibility** — always (versions, extensions, frameworks)
|
|
70
|
+
4. **Installation** — always (exact command, post-install steps)
|
|
71
|
+
5. **Minimal usage example** — always (most important)
|
|
72
|
+
6. **Configuration** — if config publish, env vars, or registration needed
|
|
73
|
+
7. **More examples** — if API has multiple entry points
|
|
74
|
+
8. **Development / testing** — for maintainers/contributors
|
|
75
|
+
9. **Contributing** — if open/team project
|
|
76
|
+
10. **License** — if applicable
|
|
77
|
+
|
|
78
|
+
Skip sections with no real content. Never pad.
|
|
79
|
+
|
|
80
|
+
### 4. Write requirements and compatibility
|
|
81
|
+
|
|
82
|
+
State only what is tested and supported:
|
|
83
|
+
|
|
84
|
+
```
|
|
85
|
+
## Requirements
|
|
86
|
+
|
|
87
|
+
- PHP ^8.2
|
|
88
|
+
- Laravel 11.x
|
|
89
|
+
- ext-json
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Don't imply broad compatibility if only tested in narrow range. Include
|
|
93
|
+
framework version, language version, required extensions, services.
|
|
94
|
+
|
|
95
|
+
### 5. Write installation that actually works
|
|
96
|
+
|
|
97
|
+
Exact install command and required follow-up:
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
composer require vendor/package
|
|
101
|
+
|
|
102
|
+
# If framework integration needed:
|
|
103
|
+
php artisan vendor:publish --tag=package-config
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
Validate each step against the codebase. Include post-install steps
|
|
107
|
+
(publish, register, env setup) if required.
|
|
108
|
+
|
|
109
|
+
### 6. Write minimal working example
|
|
110
|
+
|
|
111
|
+
**Most critical section.** Rules:
|
|
112
|
+
|
|
113
|
+
- Smallest possible working example — one use case, one result
|
|
114
|
+
- Real API calls, not pseudo-code
|
|
115
|
+
- Copy-pasteable without hidden setup
|
|
116
|
+
- Show expected result or effect if helpful
|
|
117
|
+
- Must match actual package API (verify against source)
|
|
118
|
+
|
|
119
|
+
Bad: abstract, large, requires unexplained setup.
|
|
120
|
+
Good: 5-15 lines, directly relevant, immediately runnable.
|
|
121
|
+
|
|
122
|
+
### 7. Keep architecture out of README — use reference-split
|
|
123
|
+
|
|
124
|
+
Move deep content to dedicated docs. Recommended layout:
|
|
125
|
+
|
|
126
|
+
```
|
|
127
|
+
README.md ← entry: what, why, install, minimal usage
|
|
128
|
+
docs/
|
|
129
|
+
installation.md ← full install matrix, post-install steps
|
|
130
|
+
usage.md ← extended examples, common patterns
|
|
131
|
+
architecture.md ← internal design, decisions
|
|
132
|
+
api.md ← full API reference
|
|
133
|
+
migration.md ← version upgrade guides
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
Multi-platform install (> 5 variants): prefer single table with deep
|
|
137
|
+
links over stacked inline blocks. Occasionally-needed detail (long
|
|
138
|
+
platform quirks, troubleshooting): use `<details>` — never for install,
|
|
139
|
+
first example, or requirements.
|
|
140
|
+
|
|
141
|
+
→ See `guidelines/docs/readme-size-and-splitting.md` for thresholds,
|
|
142
|
+
deep-link-table pattern, collapsibles, anti-patterns (premature
|
|
143
|
+
splitting, duplication between README and `/docs/`).
|
|
144
|
+
|
|
145
|
+
README = enough to adopt. Docs = enough to master.
|
|
146
|
+
|
|
147
|
+
### 8. Validate
|
|
148
|
+
|
|
149
|
+
- [ ] Install command is correct and complete
|
|
150
|
+
- [ ] Compatibility/requirements match `composer.json` / `package.json` / CI matrix
|
|
151
|
+
- [ ] First example matches real API (verified against source)
|
|
152
|
+
- [ ] All documented commands exist in repo
|
|
153
|
+
- [ ] No invented features or capabilities
|
|
154
|
+
- [ ] Consumer can get started without reading source code
|
|
155
|
+
- [ ] Deep content in docs, not README (see size guideline)
|
|
156
|
+
- [ ] Multi-platform install uses a table, not stacked blocks
|
|
157
|
+
- [ ] No duplication between README and `/docs/`
|
|
158
|
+
- [ ] First screen shows: what, install, requirements
|
|
159
|
+
|
|
160
|
+
## Output format
|
|
161
|
+
|
|
162
|
+
1. Full README draft
|
|
163
|
+
2. Detected package type + audience
|
|
164
|
+
3. Compatibility summary
|
|
165
|
+
4. Uncertainties needing confirmation
|
|
166
|
+
5. Suggested follow-up docs if README would become too large
|
|
167
|
+
|
|
168
|
+
## Gotcha
|
|
169
|
+
|
|
170
|
+
- Model writes package READMEs like app READMEs (too much architecture)
|
|
171
|
+
- Model invents compatibility claims or setup steps
|
|
172
|
+
- First example often too large, too abstract, or uses pseudo-code
|
|
173
|
+
- Model over-explains internals before showing how to use the package
|
|
174
|
+
- Existing README may be outdated — verify against `composer.json` / source
|
|
175
|
+
- Model forgets post-install steps (config publish, service provider, env vars)
|
|
176
|
+
|
|
177
|
+
## Do NOT
|
|
178
|
+
|
|
179
|
+
- Do NOT invent package capabilities or compatibility
|
|
180
|
+
- Do NOT skip the minimal working example
|
|
181
|
+
- Do NOT prioritize internal architecture over user onboarding
|
|
182
|
+
- Do NOT document commands not in the repo
|
|
183
|
+
- Do NOT hide requirements or version constraints
|
|
184
|
+
- Do NOT write a giant example when 10 lines would do
|
|
185
|
+
- Do NOT overload README with reference material — link to /docs
|
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: receiving-code-review
|
|
3
|
+
description: "Use when processing code review feedback (bot or human) before changing anything — triages, verifies, and pushes back with technical reasoning — even when the user just says 'fix the comments'."
|
|
4
|
+
personas:
|
|
5
|
+
- critical-challenger
|
|
6
|
+
source: package
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# receiving-code-review
|
|
10
|
+
|
|
11
|
+
## When to use
|
|
12
|
+
|
|
13
|
+
* PR has review comments (bots like Copilot, Greptile, Augment, or human
|
|
14
|
+
reviewers) and the next step is addressing them
|
|
15
|
+
* Someone pasted review feedback and asks you to "fix it" or "handle it"
|
|
16
|
+
* A pair-programming partner gave verbal suggestions about code you
|
|
17
|
+
just wrote
|
|
18
|
+
* You are tempted to reply "you are absolutely right" before reading
|
|
19
|
+
the rest of the comment
|
|
20
|
+
|
|
21
|
+
Do NOT use when:
|
|
22
|
+
|
|
23
|
+
* You are writing a review yourself (different discipline)
|
|
24
|
+
* User explicitly asks for blind implementation of a specific change
|
|
25
|
+
not framed as review feedback
|
|
26
|
+
* Pure style/formatting the linter should decide automatically — run
|
|
27
|
+
the linter
|
|
28
|
+
|
|
29
|
+
## Goal
|
|
30
|
+
|
|
31
|
+
Treat review feedback as **suggestions to evaluate**, not orders to
|
|
32
|
+
execute. Separate correct feedback from reviewer confusion. Push back
|
|
33
|
+
with technical reasoning when the suggestion is wrong for this
|
|
34
|
+
codebase. Never agree performatively.
|
|
35
|
+
|
|
36
|
+
## The Iron Law
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
NO IMPLEMENTATION UNTIL THE FEEDBACK IS UNDERSTOOD AND VERIFIED.
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
A "fix" implemented against a misread comment is worse than no fix —
|
|
43
|
+
ships the wrong behavior under the label of "addressed feedback".
|
|
44
|
+
|
|
45
|
+
## Procedure
|
|
46
|
+
|
|
47
|
+
### 1. Read the full comment set before touching code
|
|
48
|
+
|
|
49
|
+
Read **every** open comment on the PR first. Comments often relate to
|
|
50
|
+
each other — fixing comment #3 in isolation can conflict with #5. Group:
|
|
51
|
+
|
|
52
|
+
* **Blocking** — breaks behavior, introduces a bug, security issue
|
|
53
|
+
* **Important** — logic correct but design / readability issue
|
|
54
|
+
* **Minor** — naming, comment style, formatting the linter missed
|
|
55
|
+
* **Wrong** — reviewer misunderstood the code, or suggestion regresses
|
|
56
|
+
another behavior
|
|
57
|
+
|
|
58
|
+
### 2. Restate each comment in your own words
|
|
59
|
+
|
|
60
|
+
For every comment, write (internally or to the user): *"The reviewer
|
|
61
|
+
is asking me to X because Y."*
|
|
62
|
+
|
|
63
|
+
Cannot complete that sentence confidently → the comment is unclear. Ask
|
|
64
|
+
for clarification **before** implementing anything. Do not implement
|
|
65
|
+
the clear ones first and ask later — they may be linked.
|
|
66
|
+
|
|
67
|
+
### 3. Verify each claim against the code
|
|
68
|
+
|
|
69
|
+
For each blocking/important comment:
|
|
70
|
+
|
|
71
|
+
* Reproduce the alleged issue locally (run the test, hit the endpoint,
|
|
72
|
+
read the actual runtime value — see [`systematic-debugging`](../systematic-debugging/SKILL.md))
|
|
73
|
+
* Check what the code actually does, not what the reviewer **thinks**
|
|
74
|
+
it does
|
|
75
|
+
* Check whether the suggested fix would break another test or caller
|
|
76
|
+
* Check `git blame` / history — current code may be that way for a reason
|
|
77
|
+
* **Consult memory for prior context.** Via
|
|
78
|
+
[`memory-access`](../../guidelines/agent-infra/memory-access.md),
|
|
79
|
+
call `retrieve(types=["historical-patterns", "architecture-decisions"],
|
|
80
|
+
keys=<files in the review>, limit=3)`. A registered historical pattern
|
|
81
|
+
may confirm the reviewer's concern (accept) or an architecture
|
|
82
|
+
decision may explain why the current shape is intentional (push back
|
|
83
|
+
with the cited `id`).
|
|
84
|
+
|
|
85
|
+
### 4. Decide: accept, push back, or escalate
|
|
86
|
+
|
|
87
|
+
| Situation | Response |
|
|
88
|
+
|---|---|
|
|
89
|
+
| Reviewer right, fix local, no caller impact | Implement, reference the comment in the commit message |
|
|
90
|
+
| Reviewer right but fix affects other callers | Note downstream effects in the reply, then implement |
|
|
91
|
+
| Reviewer wrong — misreading the code | Reply with evidence (specific line / test / value), do not change code |
|
|
92
|
+
| Reviewer suggests a feature the codebase does not use (YAGNI) | Reply asking whether the feature is actually needed, do not build speculatively |
|
|
93
|
+
| Reviewer and user / architecture disagree | Escalate to the user before implementing either path |
|
|
94
|
+
|
|
95
|
+
### 5. Reply in the right place, with the right tone
|
|
96
|
+
|
|
97
|
+
* Inline PR comments → reply **in the thread** of that comment, not as
|
|
98
|
+
a top-level PR comment
|
|
99
|
+
* Quote **evidence**, not opinion — "line 47 already handles this via
|
|
100
|
+
`$x->isNull()`" beats "I think that's fine"
|
|
101
|
+
* No flattery. No "great catch", "absolutely right", "thanks for
|
|
102
|
+
noticing". The `language-and-tone` rule already bans this — actions
|
|
103
|
+
are the acknowledgement
|
|
104
|
+
* If you were wrong in your earlier pushback, state it factually and
|
|
105
|
+
move on. No long apology
|
|
106
|
+
|
|
107
|
+
### 6. Implement in priority order, one at a time
|
|
108
|
+
|
|
109
|
+
1. Blocking issues first
|
|
110
|
+
2. Important issues next
|
|
111
|
+
3. Minor issues last (or bundle into a single commit)
|
|
112
|
+
4. Wrong / YAGNI: no code change, only a reply with reasoning
|
|
113
|
+
|
|
114
|
+
Run relevant tests and linters **between** each group — do not batch
|
|
115
|
+
four changes and then run tests once. See
|
|
116
|
+
[`verify-before-complete`](../verify-before-complete/SKILL.md).
|
|
117
|
+
|
|
118
|
+
## Output format
|
|
119
|
+
|
|
120
|
+
When reporting back to the user after handling review:
|
|
121
|
+
|
|
122
|
+
1. **Triage table** — comment → classification → decision
|
|
123
|
+
2. **Implemented changes** — bullet per change with file + commit ref
|
|
124
|
+
3. **Pushed back** — bullet per rejected comment with the evidence
|
|
125
|
+
4. **Outstanding** — anything awaiting clarification, with the specific
|
|
126
|
+
question
|
|
127
|
+
|
|
128
|
+
## Gotchas
|
|
129
|
+
|
|
130
|
+
* Bot comments (Copilot, Greptile) are **not** automatically right.
|
|
131
|
+
Frequently flag false positives on patterns the codebase uses
|
|
132
|
+
deliberately. Verify like a human comment.
|
|
133
|
+
* A comment reading like a question ("should this be X?") is often a
|
|
134
|
+
polite way of saying "change it to X". Ask if unclear.
|
|
135
|
+
* Resolving a comment in the GitHub UI without an accompanying fix or
|
|
136
|
+
reply silently marks it handled — reviewers may miss the lack of
|
|
137
|
+
substance.
|
|
138
|
+
* Stacked PRs — a comment on the base PR may already be fixed in the
|
|
139
|
+
child PR. Check both before touching code.
|
|
140
|
+
* A suggestion that passes review aesthetics but fails the test suite
|
|
141
|
+
is still a regression. Run tests even when "the change is trivial".
|
|
142
|
+
* Flattery leaks in as "good point" or "thanks". Delete before sending.
|
|
143
|
+
|
|
144
|
+
## Do NOT
|
|
145
|
+
|
|
146
|
+
* Do NOT reply "you are absolutely right", "great catch", or any
|
|
147
|
+
flattery variant — actions acknowledge, words do not
|
|
148
|
+
* Do NOT implement a suggestion before verifying it against the code
|
|
149
|
+
* Do NOT fix the clear items first and ask about the unclear ones later
|
|
150
|
+
when the items are linked
|
|
151
|
+
* Do NOT accept a reviewer's suggestion that conflicts with an explicit
|
|
152
|
+
architectural decision without raising it
|
|
153
|
+
* Do NOT batch multiple unrelated fixes into one commit — reviewers
|
|
154
|
+
cannot re-review selectively
|
|
155
|
+
* Do NOT mark a comment resolved without either a code change or a
|
|
156
|
+
reply with reasoning
|
|
157
|
+
|
|
158
|
+
## Anti-patterns
|
|
159
|
+
|
|
160
|
+
* Replying "Fixed!" after a commit that does not actually address the
|
|
161
|
+
comment (wrong file, missed case)
|
|
162
|
+
* Rewriting the comment author's suggestion into your own words without
|
|
163
|
+
checking whether the reinterpretation still matches intent
|
|
164
|
+
* Implementing the YAGNI-suggested feature "just in case" the reviewer
|
|
165
|
+
comes back
|
|
166
|
+
* Silent disagreement — ignoring a comment without a reply
|
|
167
|
+
|
|
168
|
+
## When to hand over to another skill / command
|
|
169
|
+
|
|
170
|
+
* Executing fixes across many comments → [`fix-pr-comments`](../../commands/fix-pr-comments.md)
|
|
171
|
+
(handles both bot + developer), [`fix-pr-bot-comments`](../../commands/fix-pr-bot-comments.md),
|
|
172
|
+
[`fix-pr-developer-comments`](../../commands/fix-pr-developer-comments.md)
|
|
173
|
+
* Running the full verification gate before pushing replies →
|
|
174
|
+
[`verify-before-complete`](../verify-before-complete/SKILL.md)
|
|
175
|
+
* Writing the commit message that references the review →
|
|
176
|
+
[`conventional-commits-writing`](../conventional-commits-writing/SKILL.md)
|
|
177
|
+
* Digging into *why* the reviewer's scenario actually fails →
|
|
178
|
+
[`systematic-debugging`](../systematic-debugging/SKILL.md)
|
|
179
|
+
|
|
180
|
+
## Validation checklist
|
|
181
|
+
|
|
182
|
+
Before considering review handling done:
|
|
183
|
+
|
|
184
|
+
* [ ] Every open comment read, classified, decision made
|
|
185
|
+
* [ ] No comment implemented without a one-sentence restatement
|
|
186
|
+
* [ ] Every implemented fix verified by a test or runtime check
|
|
187
|
+
* [ ] Every rejected comment has a reply quoting evidence
|
|
188
|
+
* [ ] No comment marked resolved without code change or reply
|
|
189
|
+
* [ ] No reply contains flattery
|
|
190
|
+
* [ ] Linters and relevant tests pass after the changes
|