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,373 @@
|
|
|
1
|
+
# Implementation Plan: [Feature Name]
|
|
2
|
+
|
|
3
|
+
**Created:** [YYYY-MM-DD]
|
|
4
|
+
**Author:** [Name]
|
|
5
|
+
**Status:** [Draft / Approved / In Progress / Complete]
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
|
|
11
|
+
### Feature Summary
|
|
12
|
+
[Brief description of what will be implemented - 2-3 sentences]
|
|
13
|
+
|
|
14
|
+
### Goals
|
|
15
|
+
- [Goal 1]
|
|
16
|
+
- [Goal 2]
|
|
17
|
+
- [Goal 3]
|
|
18
|
+
|
|
19
|
+
### Non-Goals (Out of Scope)
|
|
20
|
+
- [What this implementation will NOT include]
|
|
21
|
+
- [Explicitly deferred items]
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## Background
|
|
26
|
+
|
|
27
|
+
### Context
|
|
28
|
+
[Why this feature is needed, business context, user requests]
|
|
29
|
+
|
|
30
|
+
### Related Work
|
|
31
|
+
- [Related feature/PR/issue]
|
|
32
|
+
- [Previous attempts or related implementations]
|
|
33
|
+
|
|
34
|
+
### Requirements Reference
|
|
35
|
+
- Requirements Doc: [link]
|
|
36
|
+
- Design Spec: [link]
|
|
37
|
+
- Figma: [link]
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Architecture
|
|
42
|
+
|
|
43
|
+
### High-Level Design
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
[ASCII diagram or description of architecture]
|
|
47
|
+
|
|
48
|
+
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
|
49
|
+
│ Component │ --> │ Service │ --> │ API │
|
|
50
|
+
└─────────────┘ └─────────────┘ └─────────────┘
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Component Hierarchy
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
[FeatureName]/
|
|
57
|
+
├── index.ts
|
|
58
|
+
├── [FeatureName].tsx
|
|
59
|
+
├── [FeatureName].test.tsx
|
|
60
|
+
├── [FeatureName].styles.ts
|
|
61
|
+
├── components/
|
|
62
|
+
│ ├── [SubComponent1].tsx
|
|
63
|
+
│ └── [SubComponent2].tsx
|
|
64
|
+
├── hooks/
|
|
65
|
+
│ └── use[Feature].ts
|
|
66
|
+
├── services/
|
|
67
|
+
│ └── [feature]Service.ts
|
|
68
|
+
├── utils/
|
|
69
|
+
│ └── [feature]Utils.ts
|
|
70
|
+
└── types.ts
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Data Flow
|
|
74
|
+
|
|
75
|
+
1. User triggers [action]
|
|
76
|
+
2. Component calls [service/hook]
|
|
77
|
+
3. [Service] makes API request to [endpoint]
|
|
78
|
+
4. Response updates [state]
|
|
79
|
+
5. UI re-renders with new data
|
|
80
|
+
|
|
81
|
+
### State Management
|
|
82
|
+
|
|
83
|
+
| State | Type | Location | Purpose |
|
|
84
|
+
|-------|------|----------|---------|
|
|
85
|
+
| [state1] | Local | Component | [purpose] |
|
|
86
|
+
| [state2] | Global | Store | [purpose] |
|
|
87
|
+
| [state3] | Server | React Query | [purpose] |
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## API Changes
|
|
92
|
+
|
|
93
|
+
### New Endpoints
|
|
94
|
+
|
|
95
|
+
#### `POST /api/[resource]`
|
|
96
|
+
|
|
97
|
+
**Request:**
|
|
98
|
+
```json
|
|
99
|
+
{
|
|
100
|
+
"field1": "string",
|
|
101
|
+
"field2": 123
|
|
102
|
+
}
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
**Response:**
|
|
106
|
+
```json
|
|
107
|
+
{
|
|
108
|
+
"id": "string",
|
|
109
|
+
"field1": "string",
|
|
110
|
+
"field2": 123,
|
|
111
|
+
"createdAt": "2024-01-15T10:00:00Z"
|
|
112
|
+
}
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Modified Endpoints
|
|
116
|
+
|
|
117
|
+
| Endpoint | Change | Backward Compatible |
|
|
118
|
+
|----------|--------|---------------------|
|
|
119
|
+
| [endpoint] | [change] | [Yes/No] |
|
|
120
|
+
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
## Database Changes
|
|
124
|
+
|
|
125
|
+
### New Tables/Collections
|
|
126
|
+
|
|
127
|
+
```sql
|
|
128
|
+
CREATE TABLE [table_name] (
|
|
129
|
+
id UUID PRIMARY KEY,
|
|
130
|
+
field1 VARCHAR(255) NOT NULL,
|
|
131
|
+
field2 INTEGER,
|
|
132
|
+
created_at TIMESTAMP DEFAULT NOW()
|
|
133
|
+
);
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Schema Modifications
|
|
137
|
+
|
|
138
|
+
| Table | Change | Migration Required |
|
|
139
|
+
|-------|--------|-------------------|
|
|
140
|
+
| [table] | [change] | [Yes/No] |
|
|
141
|
+
|
|
142
|
+
### Migration Strategy
|
|
143
|
+
|
|
144
|
+
- [ ] Migration script created
|
|
145
|
+
- [ ] Rollback script created
|
|
146
|
+
- [ ] Zero-downtime migration plan (if needed)
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
## File Changes
|
|
151
|
+
|
|
152
|
+
### New Files
|
|
153
|
+
|
|
154
|
+
| File Path | Purpose | Priority |
|
|
155
|
+
|-----------|---------|----------|
|
|
156
|
+
| `src/components/[Feature]/index.ts` | Main export | P1 |
|
|
157
|
+
| `src/components/[Feature]/[Feature].tsx` | Main component | P1 |
|
|
158
|
+
| `src/components/[Feature]/[Feature].test.tsx` | Tests | P1 |
|
|
159
|
+
| `src/hooks/use[Feature].ts` | Custom hook | P1 |
|
|
160
|
+
| `src/services/[feature]Service.ts` | API service | P1 |
|
|
161
|
+
|
|
162
|
+
### Modified Files
|
|
163
|
+
|
|
164
|
+
| File Path | Changes | Risk Level |
|
|
165
|
+
|-----------|---------|------------|
|
|
166
|
+
| `src/App.tsx` | Add route | Low |
|
|
167
|
+
| `src/store/index.ts` | Add reducer | Low |
|
|
168
|
+
| `src/types/index.ts` | Add types | Low |
|
|
169
|
+
|
|
170
|
+
### Files to Review
|
|
171
|
+
|
|
172
|
+
| File Path | Reason |
|
|
173
|
+
|-----------|--------|
|
|
174
|
+
| [path] | [might need changes based on implementation] |
|
|
175
|
+
|
|
176
|
+
---
|
|
177
|
+
|
|
178
|
+
## Implementation Phases
|
|
179
|
+
|
|
180
|
+
### Phase 1: Foundation
|
|
181
|
+
**Duration:** [X days]
|
|
182
|
+
|
|
183
|
+
- [ ] Task 1.1: Set up file structure
|
|
184
|
+
- [ ] Task 1.2: Create type definitions
|
|
185
|
+
- [ ] Task 1.3: Set up routing (if needed)
|
|
186
|
+
|
|
187
|
+
**Deliverable:** Basic structure in place
|
|
188
|
+
|
|
189
|
+
### Phase 2: Core Implementation
|
|
190
|
+
**Duration:** [X days]
|
|
191
|
+
|
|
192
|
+
- [ ] Task 2.1: Implement main component
|
|
193
|
+
- [ ] Task 2.2: Implement service layer
|
|
194
|
+
- [ ] Task 2.3: Implement state management
|
|
195
|
+
- [ ] Task 2.4: Implement API integration
|
|
196
|
+
|
|
197
|
+
**Deliverable:** Core functionality working
|
|
198
|
+
|
|
199
|
+
### Phase 3: UI/UX
|
|
200
|
+
**Duration:** [X days]
|
|
201
|
+
|
|
202
|
+
- [ ] Task 3.1: Implement UI components
|
|
203
|
+
- [ ] Task 3.2: Add styling
|
|
204
|
+
- [ ] Task 3.3: Add loading states
|
|
205
|
+
- [ ] Task 3.4: Add error handling UI
|
|
206
|
+
- [ ] Task 3.5: Add animations (if needed)
|
|
207
|
+
|
|
208
|
+
**Deliverable:** UI complete and polished
|
|
209
|
+
|
|
210
|
+
### Phase 4: Testing
|
|
211
|
+
**Duration:** [X days]
|
|
212
|
+
|
|
213
|
+
- [ ] Task 4.1: Write unit tests
|
|
214
|
+
- [ ] Task 4.2: Write integration tests
|
|
215
|
+
- [ ] Task 4.3: Manual testing
|
|
216
|
+
- [ ] Task 4.4: Fix bugs found
|
|
217
|
+
|
|
218
|
+
**Deliverable:** Feature tested and stable
|
|
219
|
+
|
|
220
|
+
### Phase 5: Documentation & Cleanup
|
|
221
|
+
**Duration:** [X days]
|
|
222
|
+
|
|
223
|
+
- [ ] Task 5.1: Add code documentation
|
|
224
|
+
- [ ] Task 5.2: Update README/docs
|
|
225
|
+
- [ ] Task 5.3: Code cleanup
|
|
226
|
+
- [ ] Task 5.4: Final review
|
|
227
|
+
|
|
228
|
+
**Deliverable:** Feature ready for deployment
|
|
229
|
+
|
|
230
|
+
---
|
|
231
|
+
|
|
232
|
+
## Task Dependencies
|
|
233
|
+
|
|
234
|
+
```
|
|
235
|
+
Task 1.1 ──┬── Task 2.1 ──┬── Task 3.1 ──── Task 4.1
|
|
236
|
+
│ │
|
|
237
|
+
Task 1.2 ──┤ ├── Task 3.2 ──── Task 4.2
|
|
238
|
+
│ │
|
|
239
|
+
Task 1.3 ──┴── Task 2.2 ──┴── Task 2.3 ──── Task 4.3
|
|
240
|
+
│
|
|
241
|
+
└────── Task 5.1
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
---
|
|
245
|
+
|
|
246
|
+
## Risk Assessment
|
|
247
|
+
|
|
248
|
+
### Technical Risks
|
|
249
|
+
|
|
250
|
+
| Risk | Probability | Impact | Mitigation |
|
|
251
|
+
|------|-------------|--------|------------|
|
|
252
|
+
| [Risk 1] | [H/M/L] | [H/M/L] | [Strategy] |
|
|
253
|
+
| [Risk 2] | [H/M/L] | [H/M/L] | [Strategy] |
|
|
254
|
+
|
|
255
|
+
### Integration Risks
|
|
256
|
+
|
|
257
|
+
| Risk | Probability | Impact | Mitigation |
|
|
258
|
+
|------|-------------|--------|------------|
|
|
259
|
+
| [Risk 1] | [H/M/L] | [H/M/L] | [Strategy] |
|
|
260
|
+
|
|
261
|
+
### Schedule Risks
|
|
262
|
+
|
|
263
|
+
| Risk | Probability | Impact | Mitigation |
|
|
264
|
+
|------|-------------|--------|------------|
|
|
265
|
+
| [Risk 1] | [H/M/L] | [H/M/L] | [Strategy] |
|
|
266
|
+
|
|
267
|
+
---
|
|
268
|
+
|
|
269
|
+
## Testing Strategy
|
|
270
|
+
|
|
271
|
+
### Unit Tests
|
|
272
|
+
|
|
273
|
+
| Component/Function | Test Cases | Priority |
|
|
274
|
+
|-------------------|------------|----------|
|
|
275
|
+
| [Component] | [cases] | P1 |
|
|
276
|
+
| [Function] | [cases] | P1 |
|
|
277
|
+
|
|
278
|
+
### Integration Tests
|
|
279
|
+
|
|
280
|
+
| Flow | Components | Priority |
|
|
281
|
+
|------|-----------|----------|
|
|
282
|
+
| [Flow 1] | [components] | P1 |
|
|
283
|
+
|
|
284
|
+
### E2E Tests
|
|
285
|
+
|
|
286
|
+
| User Journey | Priority |
|
|
287
|
+
|--------------|----------|
|
|
288
|
+
| [Journey 1] | P1 |
|
|
289
|
+
|
|
290
|
+
### Test Coverage Target
|
|
291
|
+
|
|
292
|
+
- Statements: 80%
|
|
293
|
+
- Branches: 75%
|
|
294
|
+
- Functions: 80%
|
|
295
|
+
|
|
296
|
+
---
|
|
297
|
+
|
|
298
|
+
## Rollback Plan
|
|
299
|
+
|
|
300
|
+
### Code Rollback
|
|
301
|
+
```bash
|
|
302
|
+
# Revert to previous version
|
|
303
|
+
git revert [commit-hash]
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
### Database Rollback
|
|
307
|
+
```bash
|
|
308
|
+
# Run rollback migration
|
|
309
|
+
[migration rollback command]
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
### Feature Flag (if applicable)
|
|
313
|
+
```javascript
|
|
314
|
+
// Disable feature
|
|
315
|
+
setFeatureFlag('feature-name', false);
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
---
|
|
319
|
+
|
|
320
|
+
## Open Questions
|
|
321
|
+
|
|
322
|
+
1. [Question 1]
|
|
323
|
+
- Context: [why this needs clarification]
|
|
324
|
+
- Options: [possible answers]
|
|
325
|
+
- Decision: [pending/decided]
|
|
326
|
+
|
|
327
|
+
2. [Question 2]
|
|
328
|
+
- Context: [why this needs clarification]
|
|
329
|
+
- Options: [possible answers]
|
|
330
|
+
- Decision: [pending/decided]
|
|
331
|
+
|
|
332
|
+
---
|
|
333
|
+
|
|
334
|
+
## Dependencies
|
|
335
|
+
|
|
336
|
+
### External Dependencies
|
|
337
|
+
- [Dependency 1]: [why needed]
|
|
338
|
+
- [Dependency 2]: [why needed]
|
|
339
|
+
|
|
340
|
+
### Internal Dependencies
|
|
341
|
+
- [Team/Service 1]: [what's needed]
|
|
342
|
+
- [Team/Service 2]: [what's needed]
|
|
343
|
+
|
|
344
|
+
---
|
|
345
|
+
|
|
346
|
+
## Success Metrics
|
|
347
|
+
|
|
348
|
+
| Metric | Target | How to Measure |
|
|
349
|
+
|--------|--------|----------------|
|
|
350
|
+
| [Metric 1] | [target] | [measurement method] |
|
|
351
|
+
| [Metric 2] | [target] | [measurement method] |
|
|
352
|
+
|
|
353
|
+
---
|
|
354
|
+
|
|
355
|
+
## Approval
|
|
356
|
+
|
|
357
|
+
| Role | Name | Date | Approved |
|
|
358
|
+
|------|------|------|----------|
|
|
359
|
+
| Tech Lead | | | [ ] |
|
|
360
|
+
| Product | | | [ ] |
|
|
361
|
+
| Design | | | [ ] |
|
|
362
|
+
|
|
363
|
+
---
|
|
364
|
+
|
|
365
|
+
## Changelog
|
|
366
|
+
|
|
367
|
+
| Date | Author | Change |
|
|
368
|
+
|------|--------|--------|
|
|
369
|
+
| [date] | [name] | Initial plan |
|
|
370
|
+
|
|
371
|
+
---
|
|
372
|
+
|
|
373
|
+
*Generated by ProAgents*
|
|
@@ -0,0 +1,331 @@
|
|
|
1
|
+
# Rollback Plan Template
|
|
2
|
+
|
|
3
|
+
Detailed rollback procedures for deployments.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Rollback Plan Header
|
|
8
|
+
|
|
9
|
+
```markdown
|
|
10
|
+
# Rollback Plan
|
|
11
|
+
|
|
12
|
+
**Feature/Release:** [Name]
|
|
13
|
+
**Version:** [Version being deployed]
|
|
14
|
+
**Previous Version:** [Version to rollback to]
|
|
15
|
+
**Date:** [YYYY-MM-DD]
|
|
16
|
+
**Prepared by:** @person
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Risk Assessment
|
|
22
|
+
|
|
23
|
+
```markdown
|
|
24
|
+
## Risk Assessment
|
|
25
|
+
|
|
26
|
+
### Rollback Complexity
|
|
27
|
+
- [ ] 🟢 Low - Simple code rollback
|
|
28
|
+
- [ ] 🟡 Medium - Code + config changes
|
|
29
|
+
- [ ] 🟠 High - Code + database changes
|
|
30
|
+
- [ ] 🔴 Critical - Data migrations involved
|
|
31
|
+
|
|
32
|
+
### Impact Analysis
|
|
33
|
+
| Component | Rollback Impact | Recovery Time |
|
|
34
|
+
|-----------|-----------------|---------------|
|
|
35
|
+
| Application | [impact] | [time] |
|
|
36
|
+
| Database | [impact] | [time] |
|
|
37
|
+
| Cache | [impact] | [time] |
|
|
38
|
+
| CDN | [impact] | [time] |
|
|
39
|
+
| External Services | [impact] | [time] |
|
|
40
|
+
|
|
41
|
+
### Data Considerations
|
|
42
|
+
- [ ] New data created after deployment
|
|
43
|
+
- [ ] Data format changes
|
|
44
|
+
- [ ] Data migrations performed
|
|
45
|
+
- [ ] External system dependencies
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Rollback Triggers
|
|
51
|
+
|
|
52
|
+
```markdown
|
|
53
|
+
## Rollback Triggers
|
|
54
|
+
|
|
55
|
+
### Automatic Triggers
|
|
56
|
+
Configure automatic rollback when:
|
|
57
|
+
```yaml
|
|
58
|
+
triggers:
|
|
59
|
+
error_rate:
|
|
60
|
+
threshold: 5%
|
|
61
|
+
duration: 5m
|
|
62
|
+
action: alert_and_prepare
|
|
63
|
+
|
|
64
|
+
response_time:
|
|
65
|
+
threshold: 200%_of_baseline
|
|
66
|
+
duration: 5m
|
|
67
|
+
action: alert_and_prepare
|
|
68
|
+
|
|
69
|
+
health_check:
|
|
70
|
+
failures: 3
|
|
71
|
+
action: auto_rollback
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Manual Triggers
|
|
75
|
+
Initiate manual rollback when:
|
|
76
|
+
- [ ] Critical functionality broken
|
|
77
|
+
- [ ] Data corruption detected
|
|
78
|
+
- [ ] Security vulnerability discovered
|
|
79
|
+
- [ ] Severe performance degradation
|
|
80
|
+
- [ ] High volume of user complaints
|
|
81
|
+
- [ ] Business-critical process impacted
|
|
82
|
+
|
|
83
|
+
### Decision Matrix
|
|
84
|
+
| Issue Severity | User Impact | Action |
|
|
85
|
+
|---------------|-------------|--------|
|
|
86
|
+
| Critical | High | Immediate rollback |
|
|
87
|
+
| Critical | Low | Rollback within 15m |
|
|
88
|
+
| High | High | Rollback within 30m |
|
|
89
|
+
| High | Low | Fix forward or rollback |
|
|
90
|
+
| Medium | Any | Fix forward preferred |
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## Rollback Procedures
|
|
96
|
+
|
|
97
|
+
```markdown
|
|
98
|
+
## Rollback Procedures
|
|
99
|
+
|
|
100
|
+
### Scenario 1: Application-Only Rollback
|
|
101
|
+
**When:** No database changes, just code
|
|
102
|
+
|
|
103
|
+
**Time estimate:** 5-10 minutes
|
|
104
|
+
|
|
105
|
+
**Steps:**
|
|
106
|
+
```bash
|
|
107
|
+
# 1. Identify previous stable version
|
|
108
|
+
git log --oneline -10
|
|
109
|
+
|
|
110
|
+
# 2. Kubernetes rollback
|
|
111
|
+
kubectl rollout undo deployment/app-name
|
|
112
|
+
|
|
113
|
+
# OR Docker rollback
|
|
114
|
+
docker-compose down
|
|
115
|
+
docker-compose up -d --no-build previous_tag
|
|
116
|
+
|
|
117
|
+
# OR Vercel rollback
|
|
118
|
+
vercel rollback [deployment-url]
|
|
119
|
+
|
|
120
|
+
# 3. Verify rollback
|
|
121
|
+
kubectl rollout status deployment/app-name
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
**Verification:**
|
|
125
|
+
- [ ] Health checks passing
|
|
126
|
+
- [ ] Smoke tests passing
|
|
127
|
+
- [ ] Error rate normalized
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
### Scenario 2: Application + Configuration Rollback
|
|
132
|
+
**When:** Environment variables or config changed
|
|
133
|
+
|
|
134
|
+
**Time estimate:** 10-15 minutes
|
|
135
|
+
|
|
136
|
+
**Steps:**
|
|
137
|
+
```bash
|
|
138
|
+
# 1. Rollback application
|
|
139
|
+
kubectl rollout undo deployment/app-name
|
|
140
|
+
|
|
141
|
+
# 2. Rollback config
|
|
142
|
+
kubectl apply -f config/previous-configmap.yaml
|
|
143
|
+
|
|
144
|
+
# 3. Restart pods to pick up config
|
|
145
|
+
kubectl rollout restart deployment/app-name
|
|
146
|
+
|
|
147
|
+
# 4. Verify
|
|
148
|
+
kubectl get pods -w
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
**Verification:**
|
|
152
|
+
- [ ] Config values correct
|
|
153
|
+
- [ ] Application functioning
|
|
154
|
+
- [ ] No config-related errors
|
|
155
|
+
|
|
156
|
+
---
|
|
157
|
+
|
|
158
|
+
### Scenario 3: Application + Database Rollback
|
|
159
|
+
**When:** Database migrations were applied
|
|
160
|
+
|
|
161
|
+
**Time estimate:** 30-60 minutes
|
|
162
|
+
|
|
163
|
+
**Steps:**
|
|
164
|
+
```bash
|
|
165
|
+
# 1. Enable maintenance mode
|
|
166
|
+
kubectl scale deployment/app-name --replicas=0
|
|
167
|
+
|
|
168
|
+
# 2. Restore database from pre-deployment backup
|
|
169
|
+
pg_restore -d database_name \
|
|
170
|
+
-h hostname \
|
|
171
|
+
-U username \
|
|
172
|
+
backup_pre_deployment.dump
|
|
173
|
+
|
|
174
|
+
# 3. Run reverse migrations (if available)
|
|
175
|
+
npm run migrate:down -- --to=previous_version
|
|
176
|
+
|
|
177
|
+
# 4. Deploy previous application version
|
|
178
|
+
kubectl set image deployment/app-name \
|
|
179
|
+
app=image:previous_tag
|
|
180
|
+
|
|
181
|
+
# 5. Scale back up
|
|
182
|
+
kubectl scale deployment/app-name --replicas=3
|
|
183
|
+
|
|
184
|
+
# 6. Disable maintenance mode
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
**Verification:**
|
|
188
|
+
- [ ] Database schema correct
|
|
189
|
+
- [ ] Data integrity verified
|
|
190
|
+
- [ ] Application working with database
|
|
191
|
+
|
|
192
|
+
---
|
|
193
|
+
|
|
194
|
+
### Scenario 4: Full System Rollback
|
|
195
|
+
**When:** Multiple services affected
|
|
196
|
+
|
|
197
|
+
**Time estimate:** 1-2 hours
|
|
198
|
+
|
|
199
|
+
**Steps:**
|
|
200
|
+
1. Activate incident response
|
|
201
|
+
2. Enable maintenance mode on all services
|
|
202
|
+
3. Stop all affected services
|
|
203
|
+
4. Restore each database from backup
|
|
204
|
+
5. Deploy previous versions of all services
|
|
205
|
+
6. Verify inter-service communication
|
|
206
|
+
7. Run full system tests
|
|
207
|
+
8. Disable maintenance mode
|
|
208
|
+
|
|
209
|
+
**Coordination:**
|
|
210
|
+
- Incident commander: @person
|
|
211
|
+
- Database team: @person
|
|
212
|
+
- Platform team: @person
|
|
213
|
+
- QA team: @person
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
## Post-Rollback Actions
|
|
219
|
+
|
|
220
|
+
```markdown
|
|
221
|
+
## Post-Rollback Actions
|
|
222
|
+
|
|
223
|
+
### Immediate (0-30 minutes)
|
|
224
|
+
- [ ] Verify system stability
|
|
225
|
+
- [ ] Monitor error rates
|
|
226
|
+
- [ ] Check critical user flows
|
|
227
|
+
- [ ] Update status page
|
|
228
|
+
- [ ] Notify stakeholders
|
|
229
|
+
|
|
230
|
+
### Short-term (30 min - 2 hours)
|
|
231
|
+
- [ ] Root cause analysis
|
|
232
|
+
- [ ] Document what went wrong
|
|
233
|
+
- [ ] Identify fix requirements
|
|
234
|
+
- [ ] Plan re-deployment strategy
|
|
235
|
+
|
|
236
|
+
### Follow-up
|
|
237
|
+
- [ ] Post-mortem meeting scheduled
|
|
238
|
+
- [ ] Fix developed and tested
|
|
239
|
+
- [ ] Additional tests added
|
|
240
|
+
- [ ] Deployment process improved
|
|
241
|
+
- [ ] Documentation updated
|
|
242
|
+
|
|
243
|
+
---
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
## Communication Templates
|
|
247
|
+
|
|
248
|
+
```markdown
|
|
249
|
+
## Communication Templates
|
|
250
|
+
|
|
251
|
+
### Rollback Initiated
|
|
252
|
+
```
|
|
253
|
+
Subject: [INCIDENT] Rollback Initiated - [Feature/Version]
|
|
254
|
+
|
|
255
|
+
Status: Rollback in progress
|
|
256
|
+
|
|
257
|
+
Issue: [Brief description of the issue]
|
|
258
|
+
Started: [Time]
|
|
259
|
+
ETA: [Estimated completion time]
|
|
260
|
+
|
|
261
|
+
Affected:
|
|
262
|
+
- [List affected services/features]
|
|
263
|
+
|
|
264
|
+
We are rolling back to version [X]. Updates will follow.
|
|
265
|
+
|
|
266
|
+
Incident Commander: @person
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
### Rollback Complete
|
|
270
|
+
```
|
|
271
|
+
Subject: [RESOLVED] Rollback Complete - [Feature/Version]
|
|
272
|
+
|
|
273
|
+
Status: Rollback successful
|
|
274
|
+
|
|
275
|
+
Summary:
|
|
276
|
+
- Issue detected: [Time]
|
|
277
|
+
- Rollback initiated: [Time]
|
|
278
|
+
- Rollback completed: [Time]
|
|
279
|
+
- Total downtime: [Duration]
|
|
280
|
+
|
|
281
|
+
Root cause: [Brief explanation]
|
|
282
|
+
|
|
283
|
+
Next steps:
|
|
284
|
+
- Post-mortem scheduled for [Date/Time]
|
|
285
|
+
- Fix ETA: [Estimate]
|
|
286
|
+
|
|
287
|
+
Apologies for any inconvenience caused.
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
### Post-Mortem Announcement
|
|
291
|
+
```
|
|
292
|
+
Subject: Post-Mortem - [Incident Date] [Brief Title]
|
|
293
|
+
|
|
294
|
+
Post-mortem document: [Link]
|
|
295
|
+
Meeting: [Date/Time]
|
|
296
|
+
|
|
297
|
+
Summary:
|
|
298
|
+
- What happened
|
|
299
|
+
- Impact
|
|
300
|
+
- Root cause
|
|
301
|
+
- Action items
|
|
302
|
+
|
|
303
|
+
All team members are encouraged to attend.
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
---
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
## Rollback Checklist
|
|
310
|
+
|
|
311
|
+
```markdown
|
|
312
|
+
## Quick Rollback Checklist
|
|
313
|
+
|
|
314
|
+
### Before Rollback
|
|
315
|
+
- [ ] Confirm rollback is necessary
|
|
316
|
+
- [ ] Identify version to rollback to
|
|
317
|
+
- [ ] Notify team of rollback
|
|
318
|
+
- [ ] Have backup plan ready
|
|
319
|
+
|
|
320
|
+
### During Rollback
|
|
321
|
+
- [ ] Execute rollback steps
|
|
322
|
+
- [ ] Monitor progress
|
|
323
|
+
- [ ] Communicate status updates
|
|
324
|
+
|
|
325
|
+
### After Rollback
|
|
326
|
+
- [ ] Verify system health
|
|
327
|
+
- [ ] Confirm fix in place
|
|
328
|
+
- [ ] Update status page
|
|
329
|
+
- [ ] Document incident
|
|
330
|
+
- [ ] Schedule post-mortem
|
|
331
|
+
```
|