proagents 1.0.0
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/LICENSE +21 -0
- package/README.md +170 -0
- package/bin/proagents.js +90 -0
- package/lib/commands/feature.js +125 -0
- package/lib/commands/fix.js +60 -0
- package/lib/commands/help.js +76 -0
- package/lib/commands/init.js +64 -0
- package/lib/commands/status.js +91 -0
- package/lib/index.js +28 -0
- package/package.json +52 -0
- package/proagents/.learning/global/common-patterns.json +77 -0
- package/proagents/.learning/global/user-preferences.json +76 -0
- package/proagents/.learning/projects/example-project/corrections.json +99 -0
- package/proagents/.learning/projects/example-project/feedback.json +109 -0
- package/proagents/.learning/projects/example-project/metrics.json +101 -0
- package/proagents/.learning/projects/example-project/patterns.json +102 -0
- package/proagents/.learning/schemas/README.md +48 -0
- package/proagents/.learning/schemas/corrections-schema.json +100 -0
- package/proagents/.learning/schemas/feedback-schema.json +144 -0
- package/proagents/.learning/schemas/metrics-schema.json +96 -0
- package/proagents/.learning/schemas/patterns-schema.json +82 -0
- package/proagents/.learning/schemas/project-patterns-schema.json +125 -0
- package/proagents/.learning/schemas/user-preferences-schema.json +136 -0
- package/proagents/GETTING-STARTED-STORY.md +708 -0
- package/proagents/README.md +99 -0
- package/proagents/WORKFLOW.md +1234 -0
- package/proagents/active-features/.gitkeep +0 -0
- package/proagents/active-features/README.md +176 -0
- package/proagents/active-features/_index.json +74 -0
- package/proagents/active-features/feature-user-auth/dependencies.json +81 -0
- package/proagents/active-features/feature-user-auth/files-modified.json +126 -0
- package/proagents/active-features/feature-user-auth/status.json +122 -0
- package/proagents/active-features/schemas/dependencies-schema.json +119 -0
- package/proagents/active-features/schemas/feature-schema.json +132 -0
- package/proagents/active-features/schemas/files-schema.json +100 -0
- package/proagents/active-features/schemas/index-schema.json +95 -0
- package/proagents/adr/README.md +302 -0
- package/proagents/adr/examples/api-versioning.md +297 -0
- package/proagents/adr/examples/database-choice.md +264 -0
- package/proagents/adr/template.md +273 -0
- package/proagents/ai-models/README.md +141 -0
- package/proagents/ai-models/cost-management.md +362 -0
- package/proagents/ai-models/fallbacks.md +342 -0
- package/proagents/ai-models/model-config.md +318 -0
- package/proagents/ai-models/task-routing.md +503 -0
- package/proagents/ai-training/README.md +155 -0
- package/proagents/ai-training/continuous-learning.md +413 -0
- package/proagents/ai-training/domain-knowledge.md +378 -0
- package/proagents/ai-training/pattern-learning.md +455 -0
- package/proagents/ai-training/training-data.md +337 -0
- package/proagents/ai-training/user-preferences.md +346 -0
- package/proagents/api-versioning/README.md +257 -0
- package/proagents/api-versioning/changelog-template.md +225 -0
- package/proagents/api-versioning/deprecation-workflow.md +470 -0
- package/proagents/api-versioning/versioning-strategy.md +291 -0
- package/proagents/approval-workflows/README.md +146 -0
- package/proagents/approval-workflows/approval-config.md +332 -0
- package/proagents/approval-workflows/approval-stages.md +503 -0
- package/proagents/approval-workflows/emergency-bypass.md +351 -0
- package/proagents/approval-workflows/examples.md +859 -0
- package/proagents/approval-workflows/notifications.md +320 -0
- package/proagents/automation/README.md +38 -0
- package/proagents/automation/ai-behavior-rules.md +339 -0
- package/proagents/automation/ai-prompt-injection.md +331 -0
- package/proagents/automation/auto-decisions.md +535 -0
- package/proagents/automation/decision-defaults.yaml +317 -0
- package/proagents/cache/README.md +110 -0
- package/proagents/cache/analysis-metadata.json +76 -0
- package/proagents/cache/conventions.json +125 -0
- package/proagents/cache/dependencies.json +85 -0
- package/proagents/cache/features.json +115 -0
- package/proagents/cache/patterns.json +105 -0
- package/proagents/cache/schemas/conventions-schema.json +138 -0
- package/proagents/cache/schemas/dependencies-schema.json +95 -0
- package/proagents/cache/schemas/features-schema.json +104 -0
- package/proagents/cache/schemas/metadata-schema.json +83 -0
- package/proagents/cache/schemas/patterns-schema.json +136 -0
- package/proagents/cache/schemas/structure-schema.json +72 -0
- package/proagents/cache/structure.json +109 -0
- package/proagents/changelog/2024/01/2024-01-10-api-url-config.md +41 -0
- package/proagents/changelog/2024/01/2024-01-12-login-bug-fix.md +69 -0
- package/proagents/changelog/2024/01/2024-01-15-user-auth-feature.md +99 -0
- package/proagents/changelog/CHANGELOG.md +82 -0
- package/proagents/changelog/README.md +327 -0
- package/proagents/changelog/entry-template.md +283 -0
- package/proagents/checklists/README.md +261 -0
- package/proagents/checklists/code-quality.md +137 -0
- package/proagents/checklists/code-review.md +148 -0
- package/proagents/checklists/pr-checklist.md +78 -0
- package/proagents/checklists/pre-deployment.md +132 -0
- package/proagents/checklists/pre-implementation.md +80 -0
- package/proagents/checklists/testing.md +120 -0
- package/proagents/cicd/README.md +338 -0
- package/proagents/cicd/azure-devops.md +267 -0
- package/proagents/cicd/github-actions.md +375 -0
- package/proagents/cicd/gitlab-ci.md +278 -0
- package/proagents/cicd/jenkins.md +317 -0
- package/proagents/cli/README.md +392 -0
- package/proagents/cli/commands-reference.md +893 -0
- package/proagents/cli/ide-integration.md +584 -0
- package/proagents/cli/shortcuts.md +394 -0
- package/proagents/cli/slash-commands.md +507 -0
- package/proagents/collaboration/README.md +143 -0
- package/proagents/collaboration/roles.md +248 -0
- package/proagents/collaboration/sessions.md +390 -0
- package/proagents/collaboration/sync.md +358 -0
- package/proagents/compliance/README.md +206 -0
- package/proagents/compliance/access-control.md +310 -0
- package/proagents/compliance/audit-logging.md +444 -0
- package/proagents/compliance/compliance-frameworks.md +429 -0
- package/proagents/compliance/reports.md +491 -0
- package/proagents/compliance/retention-policies.md +454 -0
- package/proagents/config/README.md +181 -0
- package/proagents/config/integrations/README.md +68 -0
- package/proagents/config/integrations/github.yaml +211 -0
- package/proagents/config/integrations/jira.yaml +144 -0
- package/proagents/config/integrations/linear.yaml +157 -0
- package/proagents/config/integrations/notion.yaml +203 -0
- package/proagents/config/integrations/slack.yaml +230 -0
- package/proagents/config/rules/README.md +73 -0
- package/proagents/config/rules/custom-rules.template.yaml +188 -0
- package/proagents/config/rules/validation-rules.template.yaml +177 -0
- package/proagents/config/standards/README.md +58 -0
- package/proagents/config/standards/architecture-rules.template.md +124 -0
- package/proagents/config/standards/coding-standards.template.md +107 -0
- package/proagents/config/standards/naming-conventions.template.md +114 -0
- package/proagents/config/standards/testing-standards.template.md +213 -0
- package/proagents/config/templates/README.md +74 -0
- package/proagents/config/templates/api-route.template.ts +142 -0
- package/proagents/config/templates/component.template.tsx +55 -0
- package/proagents/config/templates/hook.template.ts +93 -0
- package/proagents/config/templates/test.template.ts +171 -0
- package/proagents/config-versioning/README.md +120 -0
- package/proagents/config-versioning/changelog.md +300 -0
- package/proagents/config-versioning/rollback.md +283 -0
- package/proagents/config-versioning/versioning.md +330 -0
- package/proagents/contract-testing/README.md +223 -0
- package/proagents/contract-testing/contract-testing.md +614 -0
- package/proagents/contract-testing/pact-integration.md +507 -0
- package/proagents/contract-testing/schema-validation.md +565 -0
- package/proagents/cost/README.md +48 -0
- package/proagents/cost/cost-template.md +283 -0
- package/proagents/cost/estimation-framework.md +287 -0
- package/proagents/database/README.md +72 -0
- package/proagents/database/examples/001-create-users.sql +129 -0
- package/proagents/database/examples/002-add-preferences.sql +94 -0
- package/proagents/database/examples/003-add-index.sql +105 -0
- package/proagents/database/examples/004-rename-column.sql +122 -0
- package/proagents/database/examples/005-add-foreign-key.sql +142 -0
- package/proagents/database/examples/006-data-migration.sql +196 -0
- package/proagents/database/examples/007-drop-column.sql +163 -0
- package/proagents/database/examples/README.md +89 -0
- package/proagents/database/migration-workflow.md +478 -0
- package/proagents/database/rollback-scripts.md +487 -0
- package/proagents/database/safety-checks.md +447 -0
- package/proagents/dependency-management/README.md +140 -0
- package/proagents/dependency-management/automation.md +363 -0
- package/proagents/dependency-management/compatibility.md +319 -0
- package/proagents/dependency-management/security-scanning.md +413 -0
- package/proagents/dependency-management/update-policies.md +374 -0
- package/proagents/disaster-recovery/README.md +247 -0
- package/proagents/disaster-recovery/automation.md +366 -0
- package/proagents/disaster-recovery/backup-recovery.md +571 -0
- package/proagents/disaster-recovery/incident-response.md +565 -0
- package/proagents/disaster-recovery/rollback-procedures.md +499 -0
- package/proagents/disaster-recovery/runbooks.md +603 -0
- package/proagents/disaster-recovery/scenarios.md +892 -0
- package/proagents/disaster-recovery/testing.md +438 -0
- package/proagents/environments/README.md +244 -0
- package/proagents/environments/configuration.md +437 -0
- package/proagents/environments/promotion.md +434 -0
- package/proagents/environments/setup.md +420 -0
- package/proagents/examples/README.md +55 -0
- package/proagents/examples/backend-nodejs/README.md +188 -0
- package/proagents/examples/backend-nodejs/complete-conversation.md +601 -0
- package/proagents/examples/backend-nodejs/proagents.config.yaml +415 -0
- package/proagents/examples/backend-nodejs/workflow-example.md +909 -0
- package/proagents/examples/fullstack-nextjs/README.md +155 -0
- package/proagents/examples/fullstack-nextjs/complete-conversation.md +604 -0
- package/proagents/examples/fullstack-nextjs/proagents.config.yaml +287 -0
- package/proagents/examples/fullstack-nextjs/workflow-example.md +553 -0
- package/proagents/examples/mobile-react-native/README.md +171 -0
- package/proagents/examples/mobile-react-native/complete-conversation.md +825 -0
- package/proagents/examples/mobile-react-native/proagents.config.yaml +330 -0
- package/proagents/examples/mobile-react-native/workflow-example.md +723 -0
- package/proagents/examples/web-frontend-react/README.md +125 -0
- package/proagents/examples/web-frontend-react/complete-conversation.md +556 -0
- package/proagents/examples/web-frontend-react/proagents.config.yaml +183 -0
- package/proagents/examples/web-frontend-react/workflow-example.md +603 -0
- package/proagents/existing-projects/README.md +65 -0
- package/proagents/existing-projects/challenges.md +861 -0
- package/proagents/existing-projects/coexistence-mode.md +483 -0
- package/proagents/existing-projects/compatibility-assessment.md +541 -0
- package/proagents/existing-projects/gradual-adoption.md +515 -0
- package/proagents/existing-projects/migration-strategies.md +788 -0
- package/proagents/existing-projects/pattern-reconciliation.md +489 -0
- package/proagents/existing-projects/team-onboarding.md +617 -0
- package/proagents/existing-projects/technical-debt-handling.md +644 -0
- package/proagents/feature-flags/README.md +263 -0
- package/proagents/feature-flags/ab-testing.md +413 -0
- package/proagents/feature-flags/configuration.md +420 -0
- package/proagents/feature-flags/kill-switches.md +444 -0
- package/proagents/feature-flags/rollout-strategies.md +392 -0
- package/proagents/getting-started/README.md +60 -0
- package/proagents/getting-started/ai-training-setup.md +380 -0
- package/proagents/getting-started/ide-setup.md +195 -0
- package/proagents/getting-started/mcp-setup.md +239 -0
- package/proagents/getting-started/pm-integration.md +336 -0
- package/proagents/getting-started/prompt-engineering.md +478 -0
- package/proagents/getting-started/team-onboarding.md +236 -0
- package/proagents/git/README.md +68 -0
- package/proagents/git/branch-strategy.md +164 -0
- package/proagents/git/commit-conventions.md +241 -0
- package/proagents/git/pr-workflow.md +286 -0
- package/proagents/git/rollback-procedures.md +416 -0
- package/proagents/i18n/README.md +133 -0
- package/proagents/i18n/extraction.md +433 -0
- package/proagents/i18n/tms-integration.md +332 -0
- package/proagents/i18n/translation-workflow.md +413 -0
- package/proagents/i18n/validation.md +355 -0
- package/proagents/ide-integration/README.md +124 -0
- package/proagents/ide-integration/cline-config.md +429 -0
- package/proagents/ide-integration/continue-config.md +380 -0
- package/proagents/ide-integration/cursor-rules.md +280 -0
- package/proagents/ide-integration/github-copilot.md +384 -0
- package/proagents/ide-integration/windsurf-rules.md +314 -0
- package/proagents/integrations/README.md +97 -0
- package/proagents/integrations/pm/README.md +344 -0
- package/proagents/learning/README.md +136 -0
- package/proagents/learning/adaptation.md +305 -0
- package/proagents/learning/data-collection.md +283 -0
- package/proagents/learning/implementation-guide.md +865 -0
- package/proagents/learning/reports.md +306 -0
- package/proagents/logging/README.md +276 -0
- package/proagents/logging/aggregation.md +475 -0
- package/proagents/logging/log-levels.md +376 -0
- package/proagents/logging/sensitive-data.md +423 -0
- package/proagents/logging/structured-logging.md +406 -0
- package/proagents/mcp/README.md +133 -0
- package/proagents/mcp/context-providers.md +442 -0
- package/proagents/mcp/server-config.md +306 -0
- package/proagents/mcp/tools-definition.md +513 -0
- package/proagents/metrics/README.md +174 -0
- package/proagents/metrics/code-quality-kpis.md +461 -0
- package/proagents/metrics/deployment-metrics.md +517 -0
- package/proagents/metrics/developer-productivity.md +368 -0
- package/proagents/metrics/learning-effectiveness.md +478 -0
- package/proagents/migrations/README.md +77 -0
- package/proagents/migrations/from-claude-projects.md +312 -0
- package/proagents/migrations/from-cursor-rules.md +345 -0
- package/proagents/migrations/from-custom-workflows.md +410 -0
- package/proagents/monitoring/README.md +308 -0
- package/proagents/monitoring/alerting.md +449 -0
- package/proagents/monitoring/dashboards.md +454 -0
- package/proagents/monitoring/health-checks.md +436 -0
- package/proagents/monitoring/metrics.md +434 -0
- package/proagents/multi-project/README.md +170 -0
- package/proagents/multi-project/coordinated-deploy.md +510 -0
- package/proagents/multi-project/cross-project-deps.md +395 -0
- package/proagents/multi-project/unified-changelog.md +477 -0
- package/proagents/multi-project/walkthroughs/monorepo-setup.md +787 -0
- package/proagents/multi-project/workspace-config.md +408 -0
- package/proagents/notifications/README.md +151 -0
- package/proagents/notifications/channels.md +457 -0
- package/proagents/notifications/preferences.md +415 -0
- package/proagents/notifications/routing.md +449 -0
- package/proagents/notifications/scheduling.md +425 -0
- package/proagents/notifications/templates.md +446 -0
- package/proagents/offline-mode/README.md +145 -0
- package/proagents/offline-mode/caching.md +344 -0
- package/proagents/offline-mode/offline-operations.md +312 -0
- package/proagents/offline-mode/queue-specifications.md +679 -0
- package/proagents/offline-mode/sync.md +475 -0
- package/proagents/parallel-features/README.md +85 -0
- package/proagents/parallel-features/conflict-detection.md +226 -0
- package/proagents/parallel-features/dependency-management.md +392 -0
- package/proagents/parallel-features/merge-coordination.md +506 -0
- package/proagents/parallel-features/tracking-system.md +416 -0
- package/proagents/patterns/README.md +305 -0
- package/proagents/patterns/api-errors.md +453 -0
- package/proagents/patterns/async-errors.md +521 -0
- package/proagents/patterns/error-types.md +437 -0
- package/proagents/patterns/ui-errors.md +595 -0
- package/proagents/performance/README.md +59 -0
- package/proagents/performance/bundle-analysis.md +375 -0
- package/proagents/performance/load-testing.md +563 -0
- package/proagents/performance/runtime-metrics.md +489 -0
- package/proagents/performance/web-vitals.md +425 -0
- package/proagents/plugins/README.md +139 -0
- package/proagents/plugins/creating-plugins.md +504 -0
- package/proagents/plugins/plugin-api.md +467 -0
- package/proagents/plugins/plugin-registry.md +276 -0
- package/proagents/pm-integration/README.md +151 -0
- package/proagents/pm-integration/asana.md +346 -0
- package/proagents/pm-integration/github-issues.md +308 -0
- package/proagents/pm-integration/gitlab-issues.md +482 -0
- package/proagents/pm-integration/jira.md +364 -0
- package/proagents/pm-integration/linear.md +409 -0
- package/proagents/pm-integration/notion.md +275 -0
- package/proagents/pm-integration/sync-config.md +533 -0
- package/proagents/pm-integration/trello.md +159 -0
- package/proagents/proagents.config.yaml +213 -0
- package/proagents/prompts/00-init-wizard.md +426 -0
- package/proagents/prompts/00-init.md +219 -0
- package/proagents/prompts/01-analysis.md +244 -0
- package/proagents/prompts/02-requirements.md +399 -0
- package/proagents/prompts/03-ui-design.md +493 -0
- package/proagents/prompts/04-planning.md +505 -0
- package/proagents/prompts/05-implementation.md +518 -0
- package/proagents/prompts/06-testing.md +620 -0
- package/proagents/prompts/06.5-code-review.md +512 -0
- package/proagents/prompts/07-documentation.md +673 -0
- package/proagents/prompts/08-deployment.md +539 -0
- package/proagents/prompts/09-rollback.md +554 -0
- package/proagents/prompts/README.md +51 -0
- package/proagents/prompts/accessibility/README.md +146 -0
- package/proagents/prompts/accessibility/aria.md +276 -0
- package/proagents/prompts/accessibility/audit.md +233 -0
- package/proagents/prompts/accessibility/keyboard.md +392 -0
- package/proagents/prompts/accessibility/wcag.md +189 -0
- package/proagents/prompts/debugging/README.md +51 -0
- package/proagents/prompts/debugging/error-analysis.md +385 -0
- package/proagents/prompts/debugging/performance-debug.md +381 -0
- package/proagents/prompts/debugging/systematic.md +270 -0
- package/proagents/prompts/performance/README.md +47 -0
- package/proagents/prompts/performance/analyze.md +265 -0
- package/proagents/prompts/performance/optimize.md +347 -0
- package/proagents/prompts/refactoring/README.md +51 -0
- package/proagents/prompts/refactoring/architecture.md +531 -0
- package/proagents/prompts/refactoring/code-smells.md +174 -0
- package/proagents/prompts/refactoring/patterns.md +516 -0
- package/proagents/prompts/security-audit/README.md +197 -0
- package/proagents/prompts/security-audit/code-review.md +260 -0
- package/proagents/prompts/security-audit/vulnerability-scan.md +288 -0
- package/proagents/reporting/README.md +158 -0
- package/proagents/reporting/dashboards.md +366 -0
- package/proagents/reporting/exports.md +524 -0
- package/proagents/reporting/quality-metrics.md +385 -0
- package/proagents/reporting/templates/README.md +56 -0
- package/proagents/reporting/templates/dashboard-config.json +187 -0
- package/proagents/reporting/templates/metrics-queries.md +427 -0
- package/proagents/reporting/templates/react-dashboard.tsx +544 -0
- package/proagents/reporting/templates/widgets.md +451 -0
- package/proagents/reporting/velocity-metrics.md +340 -0
- package/proagents/reverse-engineering/README.md +151 -0
- package/proagents/reverse-engineering/architecture-extraction.md +325 -0
- package/proagents/reverse-engineering/code-analysis.md +377 -0
- package/proagents/reverse-engineering/dependency-mapping.md +567 -0
- package/proagents/reverse-engineering/diagram-generation.md +586 -0
- package/proagents/reverse-engineering/documentation-generation.md +468 -0
- package/proagents/reverse-engineering/pattern-detection.md +569 -0
- package/proagents/reverse-engineering/quality-assessment.md +733 -0
- package/proagents/rules/README.md +179 -0
- package/proagents/rules/custom-rules-template.yaml +286 -0
- package/proagents/rules/custom-rules.md +754 -0
- package/proagents/rules/validation-rules-template.yaml +517 -0
- package/proagents/runbooks/README.md +219 -0
- package/proagents/runbooks/dependency-vulnerability.md +505 -0
- package/proagents/runbooks/incident-response.md +451 -0
- package/proagents/runbooks/performance-degradation.md +584 -0
- package/proagents/runbooks/production-debugging.md +489 -0
- package/proagents/scaffolding/README.md +64 -0
- package/proagents/scaffolding/nextjs/README.md +578 -0
- package/proagents/scaffolding/nextjs/templates/api-route.ts.template +185 -0
- package/proagents/scaffolding/nextjs/templates/page.tsx.template +109 -0
- package/proagents/scaffolding/nextjs/templates/server-action.ts.template +204 -0
- package/proagents/scaffolding/nodejs/README.md +558 -0
- package/proagents/scaffolding/nodejs/templates/controller.ts.template +167 -0
- package/proagents/scaffolding/nodejs/templates/repository.ts.template +155 -0
- package/proagents/scaffolding/nodejs/templates/service.ts.template +207 -0
- package/proagents/scaffolding/project-types.md +401 -0
- package/proagents/scaffolding/react/README.md +399 -0
- package/proagents/scaffolding/react/templates/component.tsx.template +88 -0
- package/proagents/scaffolding/react/templates/hook.ts.template +127 -0
- package/proagents/scaffolding/react/templates/service.ts.template +155 -0
- package/proagents/scaffolding/react/templates/test.tsx.template +149 -0
- package/proagents/scaffolding/react-native/README.md +476 -0
- package/proagents/scaffolding/react-native/templates/hook.ts.template +226 -0
- package/proagents/scaffolding/react-native/templates/screen.tsx.template +247 -0
- package/proagents/secrets/README.md +278 -0
- package/proagents/secrets/access-control.md +443 -0
- package/proagents/secrets/rotation.md +403 -0
- package/proagents/secrets/scanning.md +487 -0
- package/proagents/secrets/storage.md +394 -0
- package/proagents/security/README.md +71 -0
- package/proagents/security/owasp-checklist.md +390 -0
- package/proagents/security/sast-guide.md +473 -0
- package/proagents/security/security-report-template.md +343 -0
- package/proagents/security/vulnerability-scanning.md +329 -0
- package/proagents/slash-commands.json +161 -0
- package/proagents/standards/README.md +120 -0
- package/proagents/standards/architecture-patterns.md +728 -0
- package/proagents/standards/architecture-rules-template.md +489 -0
- package/proagents/standards/coding-standards-template.md +489 -0
- package/proagents/standards/examples/README.md +61 -0
- package/proagents/standards/examples/nodejs-api.md +560 -0
- package/proagents/standards/examples/react-nextjs.md +428 -0
- package/proagents/standards/naming-conventions-template.md +526 -0
- package/proagents/standards/override-system.md +717 -0
- package/proagents/standards/testing-standards-template.md +220 -0
- package/proagents/team/README.md +256 -0
- package/proagents/team/code-ownership.md +306 -0
- package/proagents/team/communication-templates.md +441 -0
- package/proagents/team/handoff-protocol.md +380 -0
- package/proagents/team/ide-setup/README.md +103 -0
- package/proagents/team/ide-setup/cursor.md +276 -0
- package/proagents/team/ide-setup/jetbrains.md +330 -0
- package/proagents/team/ide-setup/neovim.md +640 -0
- package/proagents/team/ide-setup/vscode.md +348 -0
- package/proagents/team/onboarding.md +278 -0
- package/proagents/templates/README.md +57 -0
- package/proagents/templates/code-review-report.md +255 -0
- package/proagents/templates/codebase-analysis-report.md +315 -0
- package/proagents/templates/deployment-checklist.md +277 -0
- package/proagents/templates/feature-requirements.md +142 -0
- package/proagents/templates/feature-status.md +231 -0
- package/proagents/templates/implementation-plan.md +373 -0
- package/proagents/templates/rollback-plan.md +331 -0
- package/proagents/templates/test-plan.md +336 -0
- package/proagents/templates/ui-specification.md +431 -0
- package/proagents/testing-standards/README.md +229 -0
- package/proagents/testing-standards/coverage-requirements.md +198 -0
- package/proagents/testing-standards/mocking-guidelines.md +478 -0
- package/proagents/testing-standards/test-naming.md +485 -0
- package/proagents/testing-standards/test-patterns.md +488 -0
- package/proagents/troubleshooting/README.md +730 -0
- package/proagents/troubleshooting/ai-issues.md +601 -0
- package/proagents/troubleshooting/workflow-issues.md +571 -0
- package/proagents/ui-integration/README.md +77 -0
- package/proagents/ui-integration/figma-guide.md +217 -0
- package/proagents/ui-integration/manual-export-guide.md +358 -0
- package/proagents/ui-integration/sketch-interpretation.md +471 -0
- package/proagents/webhooks/README.md +126 -0
- package/proagents/webhooks/endpoints.md +298 -0
- package/proagents/webhooks/events.md +316 -0
- package/proagents/webhooks/payloads.md +325 -0
- package/proagents/webhooks/reliability.md +363 -0
- package/proagents/webhooks/security.md +380 -0
- package/proagents/workflow-modes/README.md +136 -0
- package/proagents/workflow-modes/deferred-tracking.md +405 -0
- package/proagents/workflow-modes/entry-modes.md +397 -0
- package/proagents/workflow-modes/guardrails.md +405 -0
- package/proagents/workflow-modes/mode-detection.md +358 -0
- package/proagents/workflow-modes/mode-switching.md +372 -0
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"title": "ProAgents Feature Status",
|
|
4
|
+
"description": "Schema for individual feature status tracking",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"required": ["id", "name", "workflow", "phases"],
|
|
7
|
+
"properties": {
|
|
8
|
+
"id": {
|
|
9
|
+
"type": "string",
|
|
10
|
+
"pattern": "^feature-[a-z0-9-]+$",
|
|
11
|
+
"description": "Unique feature identifier"
|
|
12
|
+
},
|
|
13
|
+
"name": {
|
|
14
|
+
"type": "string",
|
|
15
|
+
"description": "Human-readable feature name"
|
|
16
|
+
},
|
|
17
|
+
"description": {
|
|
18
|
+
"type": "string",
|
|
19
|
+
"description": "Feature description"
|
|
20
|
+
},
|
|
21
|
+
"created_at": {
|
|
22
|
+
"type": "string",
|
|
23
|
+
"format": "date-time"
|
|
24
|
+
},
|
|
25
|
+
"updated_at": {
|
|
26
|
+
"type": "string",
|
|
27
|
+
"format": "date-time"
|
|
28
|
+
},
|
|
29
|
+
"workflow": {
|
|
30
|
+
"type": "object",
|
|
31
|
+
"required": ["mode", "current_phase"],
|
|
32
|
+
"properties": {
|
|
33
|
+
"mode": {
|
|
34
|
+
"type": "string",
|
|
35
|
+
"enum": ["full", "bug_fix", "quick_change"]
|
|
36
|
+
},
|
|
37
|
+
"entry_point": {
|
|
38
|
+
"type": "string"
|
|
39
|
+
},
|
|
40
|
+
"current_phase": {
|
|
41
|
+
"type": "string"
|
|
42
|
+
},
|
|
43
|
+
"phase_progress": {
|
|
44
|
+
"type": "integer",
|
|
45
|
+
"minimum": 0,
|
|
46
|
+
"maximum": 100
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
},
|
|
50
|
+
"phases": {
|
|
51
|
+
"type": "object",
|
|
52
|
+
"additionalProperties": {
|
|
53
|
+
"type": "object",
|
|
54
|
+
"properties": {
|
|
55
|
+
"status": {
|
|
56
|
+
"type": "string",
|
|
57
|
+
"enum": ["pending", "in_progress", "completed", "skipped"]
|
|
58
|
+
},
|
|
59
|
+
"started_at": {
|
|
60
|
+
"type": "string",
|
|
61
|
+
"format": "date-time"
|
|
62
|
+
},
|
|
63
|
+
"completed_at": {
|
|
64
|
+
"type": "string",
|
|
65
|
+
"format": "date-time"
|
|
66
|
+
},
|
|
67
|
+
"duration_minutes": {
|
|
68
|
+
"type": "integer"
|
|
69
|
+
},
|
|
70
|
+
"progress": {
|
|
71
|
+
"type": "integer"
|
|
72
|
+
},
|
|
73
|
+
"artifacts": {
|
|
74
|
+
"type": "array",
|
|
75
|
+
"items": { "type": "string" }
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
},
|
|
80
|
+
"checkpoints": {
|
|
81
|
+
"type": "object",
|
|
82
|
+
"additionalProperties": {
|
|
83
|
+
"type": "object",
|
|
84
|
+
"properties": {
|
|
85
|
+
"triggered": { "type": "boolean" },
|
|
86
|
+
"approved": { "type": "boolean" },
|
|
87
|
+
"approved_by": { "type": "string" },
|
|
88
|
+
"approved_at": { "type": "string", "format": "date-time" },
|
|
89
|
+
"rejected_reason": { "type": "string" }
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
},
|
|
93
|
+
"git": {
|
|
94
|
+
"type": "object",
|
|
95
|
+
"properties": {
|
|
96
|
+
"branch": { "type": "string" },
|
|
97
|
+
"base_branch": { "type": "string" },
|
|
98
|
+
"commits": { "type": "integer" },
|
|
99
|
+
"last_commit": { "type": "string" },
|
|
100
|
+
"pr_number": { "type": ["integer", "null"] },
|
|
101
|
+
"pr_status": { "type": ["string", "null"] }
|
|
102
|
+
}
|
|
103
|
+
},
|
|
104
|
+
"assignees": {
|
|
105
|
+
"type": "object",
|
|
106
|
+
"properties": {
|
|
107
|
+
"primary": { "type": "string" },
|
|
108
|
+
"reviewers": {
|
|
109
|
+
"type": "array",
|
|
110
|
+
"items": { "type": "string" }
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
},
|
|
114
|
+
"context": {
|
|
115
|
+
"type": "object",
|
|
116
|
+
"properties": {
|
|
117
|
+
"key_decisions": {
|
|
118
|
+
"type": "array",
|
|
119
|
+
"items": { "type": "string" }
|
|
120
|
+
},
|
|
121
|
+
"open_questions": {
|
|
122
|
+
"type": "array",
|
|
123
|
+
"items": { "type": "string" }
|
|
124
|
+
},
|
|
125
|
+
"blockers": {
|
|
126
|
+
"type": "array",
|
|
127
|
+
"items": { "type": "string" }
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"$id": "active-features-files-schema.json",
|
|
4
|
+
"title": "Active Features Files Schema",
|
|
5
|
+
"description": "Schema for tracking files modified by a feature in ProAgents",
|
|
6
|
+
"type": "object",
|
|
7
|
+
"required": ["feature_id", "updated_at", "summary", "files"],
|
|
8
|
+
"properties": {
|
|
9
|
+
"$schema": {
|
|
10
|
+
"type": "string"
|
|
11
|
+
},
|
|
12
|
+
"feature_id": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"pattern": "^feature-[a-z0-9-]+$"
|
|
15
|
+
},
|
|
16
|
+
"updated_at": {
|
|
17
|
+
"type": "string",
|
|
18
|
+
"format": "date-time"
|
|
19
|
+
},
|
|
20
|
+
"summary": {
|
|
21
|
+
"type": "object",
|
|
22
|
+
"required": ["total_files"],
|
|
23
|
+
"properties": {
|
|
24
|
+
"total_files": { "type": "integer", "minimum": 0 },
|
|
25
|
+
"new_files": { "type": "integer", "minimum": 0 },
|
|
26
|
+
"modified_files": { "type": "integer", "minimum": 0 },
|
|
27
|
+
"deleted_files": { "type": "integer", "minimum": 0 },
|
|
28
|
+
"lines_added": { "type": "integer", "minimum": 0 },
|
|
29
|
+
"lines_removed": { "type": "integer", "minimum": 0 }
|
|
30
|
+
}
|
|
31
|
+
},
|
|
32
|
+
"files": {
|
|
33
|
+
"type": "array",
|
|
34
|
+
"items": {
|
|
35
|
+
"type": "object",
|
|
36
|
+
"required": ["path", "status"],
|
|
37
|
+
"properties": {
|
|
38
|
+
"path": { "type": "string" },
|
|
39
|
+
"status": {
|
|
40
|
+
"type": "string",
|
|
41
|
+
"enum": ["new", "modified", "deleted", "renamed"]
|
|
42
|
+
},
|
|
43
|
+
"lines_added": { "type": "integer", "minimum": 0 },
|
|
44
|
+
"lines_removed": { "type": "integer", "minimum": 0 },
|
|
45
|
+
"last_modified": { "type": "string", "format": "date-time" },
|
|
46
|
+
"purpose": { "type": "string" },
|
|
47
|
+
"previous_path": { "type": "string" }
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
},
|
|
51
|
+
"conflicts": {
|
|
52
|
+
"type": "object",
|
|
53
|
+
"properties": {
|
|
54
|
+
"potential": {
|
|
55
|
+
"type": "array",
|
|
56
|
+
"items": { "$ref": "#/definitions/conflict" }
|
|
57
|
+
},
|
|
58
|
+
"detected": {
|
|
59
|
+
"type": "array",
|
|
60
|
+
"items": { "$ref": "#/definitions/conflict" }
|
|
61
|
+
},
|
|
62
|
+
"resolved": {
|
|
63
|
+
"type": "array",
|
|
64
|
+
"items": { "$ref": "#/definitions/conflict" }
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
},
|
|
68
|
+
"impact_analysis": {
|
|
69
|
+
"type": "object",
|
|
70
|
+
"properties": {
|
|
71
|
+
"affected_modules": {
|
|
72
|
+
"type": "array",
|
|
73
|
+
"items": { "type": "string" }
|
|
74
|
+
},
|
|
75
|
+
"breaking_changes": { "type": "boolean" },
|
|
76
|
+
"requires_migration": { "type": "boolean" },
|
|
77
|
+
"security_sensitive": { "type": "boolean" }
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
},
|
|
81
|
+
"definitions": {
|
|
82
|
+
"conflict": {
|
|
83
|
+
"type": "object",
|
|
84
|
+
"properties": {
|
|
85
|
+
"file": { "type": "string" },
|
|
86
|
+
"with_feature": { "type": "string" },
|
|
87
|
+
"type": {
|
|
88
|
+
"type": "string",
|
|
89
|
+
"enum": ["content", "structure", "dependency"]
|
|
90
|
+
},
|
|
91
|
+
"severity": {
|
|
92
|
+
"type": "string",
|
|
93
|
+
"enum": ["low", "medium", "high"]
|
|
94
|
+
},
|
|
95
|
+
"resolved_at": { "type": "string", "format": "date-time" },
|
|
96
|
+
"resolution": { "type": "string" }
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"title": "ProAgents Feature Index",
|
|
4
|
+
"description": "Schema for the master feature tracking index",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"required": ["version", "active_features"],
|
|
7
|
+
"properties": {
|
|
8
|
+
"version": {
|
|
9
|
+
"type": "string",
|
|
10
|
+
"pattern": "^\\d+\\.\\d+\\.\\d+$"
|
|
11
|
+
},
|
|
12
|
+
"last_updated": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"format": "date-time"
|
|
15
|
+
},
|
|
16
|
+
"active_features": {
|
|
17
|
+
"type": "array",
|
|
18
|
+
"items": { "$ref": "#/definitions/active_feature" }
|
|
19
|
+
},
|
|
20
|
+
"paused_features": {
|
|
21
|
+
"type": "array",
|
|
22
|
+
"items": { "$ref": "#/definitions/paused_feature" }
|
|
23
|
+
},
|
|
24
|
+
"completed_features": {
|
|
25
|
+
"type": "array",
|
|
26
|
+
"items": { "$ref": "#/definitions/completed_feature" }
|
|
27
|
+
},
|
|
28
|
+
"conflicts": {
|
|
29
|
+
"type": "object",
|
|
30
|
+
"properties": {
|
|
31
|
+
"active": { "type": "array" },
|
|
32
|
+
"resolved": { "type": "array" }
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
"statistics": {
|
|
36
|
+
"type": "object"
|
|
37
|
+
}
|
|
38
|
+
},
|
|
39
|
+
"definitions": {
|
|
40
|
+
"active_feature": {
|
|
41
|
+
"type": "object",
|
|
42
|
+
"required": ["id", "name", "current_phase", "branch"],
|
|
43
|
+
"properties": {
|
|
44
|
+
"id": { "type": "string", "pattern": "^feature-[a-z0-9-]+$" },
|
|
45
|
+
"name": { "type": "string" },
|
|
46
|
+
"description": { "type": "string" },
|
|
47
|
+
"current_phase": {
|
|
48
|
+
"type": "string",
|
|
49
|
+
"enum": ["init", "analysis", "requirements", "design", "planning", "implementation", "testing", "review", "documentation", "deployment"]
|
|
50
|
+
},
|
|
51
|
+
"phase_progress": { "type": "integer", "minimum": 0, "maximum": 100 },
|
|
52
|
+
"branch": { "type": "string" },
|
|
53
|
+
"started": { "type": "string", "format": "date-time" },
|
|
54
|
+
"last_updated": { "type": "string", "format": "date-time" },
|
|
55
|
+
"estimated_completion": { "type": "string", "format": "date-time" },
|
|
56
|
+
"assignee": { "type": "string" },
|
|
57
|
+
"priority": { "type": "string", "enum": ["low", "medium", "high", "critical"] },
|
|
58
|
+
"blockers": { "type": "array", "items": { "type": "string" } },
|
|
59
|
+
"dependencies": { "type": "array", "items": { "type": "string" } },
|
|
60
|
+
"files_modified_count": { "type": "integer" },
|
|
61
|
+
"checkpoints_completed": { "type": "array", "items": { "type": "string" } },
|
|
62
|
+
"checkpoints_pending": { "type": "array", "items": { "type": "string" } }
|
|
63
|
+
}
|
|
64
|
+
},
|
|
65
|
+
"paused_feature": {
|
|
66
|
+
"type": "object",
|
|
67
|
+
"required": ["id", "name", "paused_at"],
|
|
68
|
+
"properties": {
|
|
69
|
+
"id": { "type": "string" },
|
|
70
|
+
"name": { "type": "string" },
|
|
71
|
+
"current_phase": { "type": "string" },
|
|
72
|
+
"phase_progress": { "type": "integer" },
|
|
73
|
+
"branch": { "type": "string" },
|
|
74
|
+
"started": { "type": "string", "format": "date-time" },
|
|
75
|
+
"paused_at": { "type": "string", "format": "date-time" },
|
|
76
|
+
"pause_reason": { "type": "string" },
|
|
77
|
+
"assignee": { "type": "string" },
|
|
78
|
+
"priority": { "type": "string" },
|
|
79
|
+
"blocked_by": { "type": "array", "items": { "type": "string" } }
|
|
80
|
+
}
|
|
81
|
+
},
|
|
82
|
+
"completed_feature": {
|
|
83
|
+
"type": "object",
|
|
84
|
+
"required": ["id", "name", "completed_at"],
|
|
85
|
+
"properties": {
|
|
86
|
+
"id": { "type": "string" },
|
|
87
|
+
"name": { "type": "string" },
|
|
88
|
+
"completed_at": { "type": "string", "format": "date-time" },
|
|
89
|
+
"duration_hours": { "type": "number" },
|
|
90
|
+
"merged_commit": { "type": "string" },
|
|
91
|
+
"pr_number": { "type": "integer" }
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
}
|
|
@@ -0,0 +1,302 @@
|
|
|
1
|
+
# Architecture Decision Records (ADR)
|
|
2
|
+
|
|
3
|
+
Document architectural decisions in a structured, maintainable format.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
Architecture Decision Records (ADRs) capture important architectural decisions along with their context and consequences. They help teams understand why decisions were made and serve as a historical record.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Quick Start
|
|
14
|
+
|
|
15
|
+
### Create a New ADR
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
# Using ProAgents command
|
|
19
|
+
/adr new "Use PostgreSQL for primary database"
|
|
20
|
+
|
|
21
|
+
# Creates: adr/0001-use-postgresql-for-primary-database.md
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
### List Existing ADRs
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
# List all ADRs
|
|
28
|
+
/adr list
|
|
29
|
+
|
|
30
|
+
# Filter by status
|
|
31
|
+
/adr list --status accepted
|
|
32
|
+
|
|
33
|
+
# Search ADRs
|
|
34
|
+
/adr search "database"
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## ADR Structure
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
/adr/
|
|
43
|
+
├── README.md # This file
|
|
44
|
+
├── template.md # ADR template
|
|
45
|
+
├── 0001-record-title.md # First decision
|
|
46
|
+
├── 0002-record-title.md # Second decision
|
|
47
|
+
└── examples/ # Example ADRs
|
|
48
|
+
├── database-choice.md
|
|
49
|
+
└── api-versioning.md
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## ADR Lifecycle
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
┌──────────┐ ┌──────────┐ ┌──────────┐
|
|
58
|
+
│ Proposed │ → │ Accepted │ → │ Superseded │
|
|
59
|
+
└──────────┘ └──────────┘ └──────────┘
|
|
60
|
+
│ │
|
|
61
|
+
└───────────────┼──────→ ┌──────────┐
|
|
62
|
+
│ │ Deprecated │
|
|
63
|
+
│ └──────────┘
|
|
64
|
+
│
|
|
65
|
+
└──────→ ┌──────────┐
|
|
66
|
+
│ Rejected │
|
|
67
|
+
└──────────┘
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Status Definitions
|
|
71
|
+
|
|
72
|
+
| Status | Description |
|
|
73
|
+
|--------|-------------|
|
|
74
|
+
| **Proposed** | Under discussion, not yet decided |
|
|
75
|
+
| **Accepted** | Decision made and in effect |
|
|
76
|
+
| **Deprecated** | Still valid but discouraged for new work |
|
|
77
|
+
| **Superseded** | Replaced by another ADR |
|
|
78
|
+
| **Rejected** | Considered but not adopted |
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## When to Write an ADR
|
|
83
|
+
|
|
84
|
+
Write an ADR when making decisions about:
|
|
85
|
+
|
|
86
|
+
- **Architecture patterns** - Microservices vs monolith, event-driven, etc.
|
|
87
|
+
- **Technology choices** - Languages, frameworks, databases, tools
|
|
88
|
+
- **Standards** - Coding conventions, API design, testing approaches
|
|
89
|
+
- **Infrastructure** - Cloud services, deployment strategies
|
|
90
|
+
- **Security** - Authentication, encryption, access control
|
|
91
|
+
- **Integration** - Third-party services, APIs, protocols
|
|
92
|
+
|
|
93
|
+
**Rule of thumb**: If the decision is significant enough that someone might ask "why did we do it this way?" in 6 months, write an ADR.
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## ADR Template
|
|
98
|
+
|
|
99
|
+
```markdown
|
|
100
|
+
# ADR-NNNN: [Title]
|
|
101
|
+
|
|
102
|
+
## Status
|
|
103
|
+
[Proposed | Accepted | Deprecated | Superseded | Rejected]
|
|
104
|
+
|
|
105
|
+
## Context
|
|
106
|
+
[Describe the situation and the problem or opportunity]
|
|
107
|
+
|
|
108
|
+
## Decision
|
|
109
|
+
[State the decision clearly]
|
|
110
|
+
|
|
111
|
+
## Consequences
|
|
112
|
+
[List the positive and negative outcomes]
|
|
113
|
+
|
|
114
|
+
## Alternatives Considered
|
|
115
|
+
[What other options were evaluated]
|
|
116
|
+
|
|
117
|
+
## References
|
|
118
|
+
[Links to related resources, discussions, ADRs]
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
See [template.md](./template.md) for the full template.
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## Best Practices
|
|
126
|
+
|
|
127
|
+
### Writing Good ADRs
|
|
128
|
+
|
|
129
|
+
1. **Be concise** - ADRs should be readable in a few minutes
|
|
130
|
+
2. **Be specific** - State exactly what was decided
|
|
131
|
+
3. **Include context** - Explain why the decision was needed
|
|
132
|
+
4. **List alternatives** - Show what else was considered
|
|
133
|
+
5. **Be honest** - Include tradeoffs and negative consequences
|
|
134
|
+
|
|
135
|
+
### Managing ADRs
|
|
136
|
+
|
|
137
|
+
1. **Number sequentially** - Use format `NNNN-title.md`
|
|
138
|
+
2. **Never delete** - Mark as superseded/deprecated instead
|
|
139
|
+
3. **Link related ADRs** - Reference related decisions
|
|
140
|
+
4. **Review periodically** - Check if decisions still apply
|
|
141
|
+
5. **Keep in source control** - ADRs are part of the codebase
|
|
142
|
+
|
|
143
|
+
### ADR Reviews
|
|
144
|
+
|
|
145
|
+
- ADRs should be reviewed like code
|
|
146
|
+
- Get input from affected stakeholders
|
|
147
|
+
- Consider creating a decision brief before writing ADR
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
## ADR Commands
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
# Create new ADR
|
|
155
|
+
/adr new "Decision title"
|
|
156
|
+
|
|
157
|
+
# Create from template
|
|
158
|
+
/adr new --template security "Implement OAuth 2.0"
|
|
159
|
+
|
|
160
|
+
# List ADRs
|
|
161
|
+
/adr list
|
|
162
|
+
/adr list --status accepted
|
|
163
|
+
/adr list --tag database
|
|
164
|
+
|
|
165
|
+
# Search ADRs
|
|
166
|
+
/adr search "authentication"
|
|
167
|
+
|
|
168
|
+
# Show ADR
|
|
169
|
+
/adr show 0001
|
|
170
|
+
|
|
171
|
+
# Update status
|
|
172
|
+
/adr status 0001 --set deprecated
|
|
173
|
+
|
|
174
|
+
# Supersede ADR
|
|
175
|
+
/adr supersede 0001 --with 0015
|
|
176
|
+
|
|
177
|
+
# Generate index
|
|
178
|
+
/adr index
|
|
179
|
+
|
|
180
|
+
# Export ADRs
|
|
181
|
+
/adr export --format html
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
---
|
|
185
|
+
|
|
186
|
+
## Configuration
|
|
187
|
+
|
|
188
|
+
```yaml
|
|
189
|
+
# proagents.config.yaml
|
|
190
|
+
adr:
|
|
191
|
+
directory: "./adr"
|
|
192
|
+
template: "./adr/template.md"
|
|
193
|
+
|
|
194
|
+
format:
|
|
195
|
+
number_width: 4
|
|
196
|
+
title_case: "kebab"
|
|
197
|
+
|
|
198
|
+
templates:
|
|
199
|
+
default: "template.md"
|
|
200
|
+
security: "templates/security-adr.md"
|
|
201
|
+
api: "templates/api-adr.md"
|
|
202
|
+
|
|
203
|
+
workflow:
|
|
204
|
+
require_review: true
|
|
205
|
+
reviewers:
|
|
206
|
+
- "@tech-lead"
|
|
207
|
+
- "@architect"
|
|
208
|
+
|
|
209
|
+
metadata:
|
|
210
|
+
tags: true
|
|
211
|
+
date: true
|
|
212
|
+
author: true
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
## Examples
|
|
218
|
+
|
|
219
|
+
### Example ADRs
|
|
220
|
+
|
|
221
|
+
- [Database Choice](./examples/database-choice.md) - Choosing PostgreSQL
|
|
222
|
+
- [API Versioning](./examples/api-versioning.md) - URL-based versioning strategy
|
|
223
|
+
|
|
224
|
+
### Quick Example
|
|
225
|
+
|
|
226
|
+
```markdown
|
|
227
|
+
# ADR-0001: Use React for Frontend Framework
|
|
228
|
+
|
|
229
|
+
## Status
|
|
230
|
+
Accepted
|
|
231
|
+
|
|
232
|
+
## Context
|
|
233
|
+
We need to choose a frontend framework for our new web application.
|
|
234
|
+
The team has experience with both React and Vue.
|
|
235
|
+
|
|
236
|
+
## Decision
|
|
237
|
+
We will use React as our frontend framework.
|
|
238
|
+
|
|
239
|
+
## Consequences
|
|
240
|
+
**Positive:**
|
|
241
|
+
- Large ecosystem and community
|
|
242
|
+
- Team already has React experience
|
|
243
|
+
- Good integration with our tooling
|
|
244
|
+
|
|
245
|
+
**Negative:**
|
|
246
|
+
- Steeper learning curve for new developers
|
|
247
|
+
- More boilerplate than some alternatives
|
|
248
|
+
|
|
249
|
+
## Alternatives Considered
|
|
250
|
+
1. **Vue.js** - Simpler but less ecosystem support
|
|
251
|
+
2. **Angular** - Too opinionated for our needs
|
|
252
|
+
3. **Svelte** - Interesting but team lacks experience
|
|
253
|
+
|
|
254
|
+
## References
|
|
255
|
+
- [React Documentation](https://react.dev)
|
|
256
|
+
- Team survey results (internal doc)
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
---
|
|
260
|
+
|
|
261
|
+
## Integration
|
|
262
|
+
|
|
263
|
+
### With Documentation
|
|
264
|
+
|
|
265
|
+
ADRs can be integrated into your documentation site:
|
|
266
|
+
|
|
267
|
+
```yaml
|
|
268
|
+
# mkdocs.yml
|
|
269
|
+
nav:
|
|
270
|
+
- Architecture:
|
|
271
|
+
- Decisions: adr/index.md
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
### With GitHub
|
|
275
|
+
|
|
276
|
+
ADR changes can trigger reviews:
|
|
277
|
+
|
|
278
|
+
```yaml
|
|
279
|
+
# .github/CODEOWNERS
|
|
280
|
+
/adr/ @tech-lead @architect
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
### With Slack
|
|
284
|
+
|
|
285
|
+
Notify team of new ADRs:
|
|
286
|
+
|
|
287
|
+
```yaml
|
|
288
|
+
adr:
|
|
289
|
+
notifications:
|
|
290
|
+
slack:
|
|
291
|
+
channel: "#architecture"
|
|
292
|
+
on_new: true
|
|
293
|
+
on_status_change: true
|
|
294
|
+
```
|
|
295
|
+
|
|
296
|
+
---
|
|
297
|
+
|
|
298
|
+
## Resources
|
|
299
|
+
|
|
300
|
+
- [ADR GitHub Organization](https://adr.github.io/)
|
|
301
|
+
- [Documenting Architecture Decisions - Michael Nygard](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions)
|
|
302
|
+
- [ADR Tools](https://github.com/npryce/adr-tools)
|