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,380 @@
|
|
|
1
|
+
# Continue Configuration
|
|
2
|
+
|
|
3
|
+
Configure Continue extension to work with ProAgents workflow.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
Continue is an open-source AI code assistant that works with VS Code and JetBrains IDEs. It supports multiple AI providers and custom configurations.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Quick Setup
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# Generate Continue configuration
|
|
17
|
+
proagents ide generate continue
|
|
18
|
+
|
|
19
|
+
# Creates .continuerc.json in project root
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Configuration File
|
|
25
|
+
|
|
26
|
+
Create `.continuerc.json` in your project root:
|
|
27
|
+
|
|
28
|
+
```json
|
|
29
|
+
{
|
|
30
|
+
"name": "ProAgents Workflow",
|
|
31
|
+
"version": "1.0.0",
|
|
32
|
+
|
|
33
|
+
"models": [
|
|
34
|
+
{
|
|
35
|
+
"title": "Claude 3.5 Sonnet",
|
|
36
|
+
"provider": "anthropic",
|
|
37
|
+
"model": "claude-3-5-sonnet-20241022",
|
|
38
|
+
"apiKey": "${ANTHROPIC_API_KEY}"
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
"title": "GPT-4o",
|
|
42
|
+
"provider": "openai",
|
|
43
|
+
"model": "gpt-4o",
|
|
44
|
+
"apiKey": "${OPENAI_API_KEY}"
|
|
45
|
+
}
|
|
46
|
+
],
|
|
47
|
+
|
|
48
|
+
"tabAutocompleteModel": {
|
|
49
|
+
"title": "Codestral",
|
|
50
|
+
"provider": "mistral",
|
|
51
|
+
"model": "codestral-latest"
|
|
52
|
+
},
|
|
53
|
+
|
|
54
|
+
"customCommands": [
|
|
55
|
+
{
|
|
56
|
+
"name": "feature",
|
|
57
|
+
"description": "Start a new feature with ProAgents workflow",
|
|
58
|
+
"prompt": "I want to implement a new feature: {{{ input }}}. Follow the ProAgents workflow:\n1. First, analyze existing patterns in the codebase\n2. Propose an implementation plan\n3. Get confirmation before coding\n4. Implement with tests\n5. Document the feature"
|
|
59
|
+
},
|
|
60
|
+
{
|
|
61
|
+
"name": "fix",
|
|
62
|
+
"description": "Fix a bug using ProAgents workflow",
|
|
63
|
+
"prompt": "Help me fix this bug: {{{ input }}}. Follow the ProAgents bug fix workflow:\n1. Identify the bug location\n2. Analyze the root cause\n3. Propose a minimal fix\n4. Add a regression test"
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
"name": "doc",
|
|
67
|
+
"description": "Generate documentation",
|
|
68
|
+
"prompt": "Generate documentation for {{{ input }}}. Include:\n- Overview\n- API reference\n- Usage examples\n- Error handling"
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
"name": "test",
|
|
72
|
+
"description": "Generate tests",
|
|
73
|
+
"prompt": "Generate comprehensive tests for {{{ input }}}. Include:\n- Unit tests for all functions\n- Edge cases\n- Error scenarios\n- Integration tests if applicable"
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
"name": "review",
|
|
77
|
+
"description": "Code review",
|
|
78
|
+
"prompt": "Review this code following ProAgents quality standards:\n- Code correctness\n- Pattern compliance\n- Error handling\n- Performance\n- Security\n- Accessibility\n\n{{{ input }}}"
|
|
79
|
+
}
|
|
80
|
+
],
|
|
81
|
+
|
|
82
|
+
"slashCommands": [
|
|
83
|
+
{
|
|
84
|
+
"name": "proagents",
|
|
85
|
+
"description": "ProAgents workflow commands",
|
|
86
|
+
"steps": [
|
|
87
|
+
{
|
|
88
|
+
"type": "prompt",
|
|
89
|
+
"prompt": "You are integrated with ProAgents workflow. Available commands:\n- /proagents feature <name> - Start new feature\n- /proagents fix <bug> - Fix a bug\n- /proagents doc - Generate documentation\n- /proagents test - Generate tests\n- /proagents review - Code review\n\nUser request: {{{ input }}}"
|
|
90
|
+
}
|
|
91
|
+
]
|
|
92
|
+
}
|
|
93
|
+
],
|
|
94
|
+
|
|
95
|
+
"contextProviders": [
|
|
96
|
+
{
|
|
97
|
+
"name": "proagents-context",
|
|
98
|
+
"params": {
|
|
99
|
+
"configPath": "./proagents/proagents.config.yaml",
|
|
100
|
+
"includePatterns": true,
|
|
101
|
+
"includeStandards": true
|
|
102
|
+
}
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"name": "codebase",
|
|
106
|
+
"params": {
|
|
107
|
+
"nRetrieve": 25,
|
|
108
|
+
"nFinal": 10,
|
|
109
|
+
"useReranking": true
|
|
110
|
+
}
|
|
111
|
+
},
|
|
112
|
+
{
|
|
113
|
+
"name": "folder",
|
|
114
|
+
"params": {}
|
|
115
|
+
},
|
|
116
|
+
{
|
|
117
|
+
"name": "diff",
|
|
118
|
+
"params": {}
|
|
119
|
+
}
|
|
120
|
+
],
|
|
121
|
+
|
|
122
|
+
"systemMessage": "You are an AI assistant integrated with the ProAgents development workflow. Follow these principles:\n\n1. **Analyze First**: Always understand existing patterns before suggesting code\n2. **Follow Conventions**: Match the project's coding standards\n3. **Quality Focus**: Include error handling, tests, and documentation\n4. **Explain Reasoning**: Describe your approach before implementing\n5. **Minimal Changes**: Make only necessary modifications\n\nProject Standards:\n- TypeScript with strict mode\n- Functional React components\n- Tailwind CSS for styling\n- Jest for testing\n- Follow existing patterns in the codebase"
|
|
123
|
+
}
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
## Custom Context Providers
|
|
129
|
+
|
|
130
|
+
### ProAgents Context Provider
|
|
131
|
+
|
|
132
|
+
Create `.continue/proagents-context.ts`:
|
|
133
|
+
|
|
134
|
+
```typescript
|
|
135
|
+
import { ContextProvider, ContextItem } from "@continuedev/core";
|
|
136
|
+
import * as fs from "fs";
|
|
137
|
+
import * as path from "path";
|
|
138
|
+
|
|
139
|
+
export class ProAgentsContextProvider implements ContextProvider {
|
|
140
|
+
name = "proagents-context";
|
|
141
|
+
description = "Provides ProAgents workflow context";
|
|
142
|
+
|
|
143
|
+
async getContextItems(query: string): Promise<ContextItem[]> {
|
|
144
|
+
const items: ContextItem[] = [];
|
|
145
|
+
const projectRoot = process.cwd();
|
|
146
|
+
|
|
147
|
+
// Load ProAgents config
|
|
148
|
+
const configPath = path.join(projectRoot, "proagents/proagents.config.yaml");
|
|
149
|
+
if (fs.existsSync(configPath)) {
|
|
150
|
+
items.push({
|
|
151
|
+
name: "ProAgents Configuration",
|
|
152
|
+
description: "Project workflow configuration",
|
|
153
|
+
content: fs.readFileSync(configPath, "utf-8"),
|
|
154
|
+
});
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
// Load active feature status
|
|
158
|
+
const featuresPath = path.join(projectRoot, "proagents/active-features");
|
|
159
|
+
if (fs.existsSync(featuresPath)) {
|
|
160
|
+
const features = fs.readdirSync(featuresPath);
|
|
161
|
+
for (const feature of features) {
|
|
162
|
+
const statusPath = path.join(featuresPath, feature, "status.json");
|
|
163
|
+
if (fs.existsSync(statusPath)) {
|
|
164
|
+
items.push({
|
|
165
|
+
name: `Feature: ${feature}`,
|
|
166
|
+
description: "Active feature status",
|
|
167
|
+
content: fs.readFileSync(statusPath, "utf-8"),
|
|
168
|
+
});
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
// Load coding standards
|
|
174
|
+
const standardsPath = path.join(projectRoot, "proagents/standards");
|
|
175
|
+
if (fs.existsSync(standardsPath)) {
|
|
176
|
+
const standards = fs.readdirSync(standardsPath).filter(f => f.endsWith('.md'));
|
|
177
|
+
for (const standard of standards.slice(0, 3)) {
|
|
178
|
+
items.push({
|
|
179
|
+
name: `Standard: ${standard}`,
|
|
180
|
+
description: "Coding standard",
|
|
181
|
+
content: fs.readFileSync(path.join(standardsPath, standard), "utf-8"),
|
|
182
|
+
});
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
return items;
|
|
187
|
+
}
|
|
188
|
+
}
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
## Workflow Prompts
|
|
194
|
+
|
|
195
|
+
### Feature Development Prompt
|
|
196
|
+
|
|
197
|
+
```json
|
|
198
|
+
{
|
|
199
|
+
"name": "proagents-feature",
|
|
200
|
+
"description": "Complete feature development workflow",
|
|
201
|
+
"steps": [
|
|
202
|
+
{
|
|
203
|
+
"type": "context",
|
|
204
|
+
"query": "Find existing patterns related to: {{{ input }}}"
|
|
205
|
+
},
|
|
206
|
+
{
|
|
207
|
+
"type": "prompt",
|
|
208
|
+
"prompt": "Based on the existing codebase patterns, create an implementation plan for: {{{ input }}}\n\nInclude:\n1. Files to create/modify\n2. Key components/functions\n3. Integration points\n4. Testing approach"
|
|
209
|
+
},
|
|
210
|
+
{
|
|
211
|
+
"type": "prompt",
|
|
212
|
+
"prompt": "Now implement the feature following the plan. Create complete, working code with proper error handling and types."
|
|
213
|
+
},
|
|
214
|
+
{
|
|
215
|
+
"type": "prompt",
|
|
216
|
+
"prompt": "Generate comprehensive tests for the implementation."
|
|
217
|
+
}
|
|
218
|
+
]
|
|
219
|
+
}
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Code Review Prompt
|
|
223
|
+
|
|
224
|
+
```json
|
|
225
|
+
{
|
|
226
|
+
"name": "proagents-review",
|
|
227
|
+
"description": "Comprehensive code review",
|
|
228
|
+
"steps": [
|
|
229
|
+
{
|
|
230
|
+
"type": "context",
|
|
231
|
+
"query": "Get project coding standards"
|
|
232
|
+
},
|
|
233
|
+
{
|
|
234
|
+
"type": "prompt",
|
|
235
|
+
"prompt": "Review the following code against ProAgents quality standards:\n\n## Checklist\n- [ ] Follows project patterns\n- [ ] Proper TypeScript types\n- [ ] Error handling\n- [ ] Performance considerations\n- [ ] Security (no vulnerabilities)\n- [ ] Accessibility\n- [ ] Test coverage\n\n## Code to Review\n{{{ input }}}\n\nProvide detailed feedback with specific suggestions."
|
|
236
|
+
}
|
|
237
|
+
]
|
|
238
|
+
}
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
---
|
|
242
|
+
|
|
243
|
+
## Model Configuration
|
|
244
|
+
|
|
245
|
+
### For Different Tasks
|
|
246
|
+
|
|
247
|
+
```json
|
|
248
|
+
{
|
|
249
|
+
"models": [
|
|
250
|
+
{
|
|
251
|
+
"title": "Claude (Code Analysis)",
|
|
252
|
+
"provider": "anthropic",
|
|
253
|
+
"model": "claude-3-5-sonnet-20241022",
|
|
254
|
+
"roles": ["chat", "edit"]
|
|
255
|
+
},
|
|
256
|
+
{
|
|
257
|
+
"title": "GPT-4 (Documentation)",
|
|
258
|
+
"provider": "openai",
|
|
259
|
+
"model": "gpt-4o",
|
|
260
|
+
"roles": ["chat"]
|
|
261
|
+
},
|
|
262
|
+
{
|
|
263
|
+
"title": "Codestral (Autocomplete)",
|
|
264
|
+
"provider": "mistral",
|
|
265
|
+
"model": "codestral-latest",
|
|
266
|
+
"roles": ["autocomplete"]
|
|
267
|
+
}
|
|
268
|
+
],
|
|
269
|
+
|
|
270
|
+
"modelRoles": {
|
|
271
|
+
"default": "Claude (Code Analysis)",
|
|
272
|
+
"summarize": "Claude (Code Analysis)",
|
|
273
|
+
"edit": "Claude (Code Analysis)",
|
|
274
|
+
"chat": "Claude (Code Analysis)"
|
|
275
|
+
}
|
|
276
|
+
}
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
### Local Models
|
|
280
|
+
|
|
281
|
+
```json
|
|
282
|
+
{
|
|
283
|
+
"models": [
|
|
284
|
+
{
|
|
285
|
+
"title": "Ollama CodeLlama",
|
|
286
|
+
"provider": "ollama",
|
|
287
|
+
"model": "codellama:13b"
|
|
288
|
+
},
|
|
289
|
+
{
|
|
290
|
+
"title": "Ollama Deepseek",
|
|
291
|
+
"provider": "ollama",
|
|
292
|
+
"model": "deepseek-coder:6.7b"
|
|
293
|
+
}
|
|
294
|
+
]
|
|
295
|
+
}
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
---
|
|
299
|
+
|
|
300
|
+
## ProAgents Integration
|
|
301
|
+
|
|
302
|
+
```yaml
|
|
303
|
+
# proagents.config.yaml
|
|
304
|
+
ide:
|
|
305
|
+
continue:
|
|
306
|
+
enabled: true
|
|
307
|
+
|
|
308
|
+
# Config output
|
|
309
|
+
config_path: ".continuerc.json"
|
|
310
|
+
|
|
311
|
+
# Custom commands to generate
|
|
312
|
+
commands:
|
|
313
|
+
- feature
|
|
314
|
+
- fix
|
|
315
|
+
- doc
|
|
316
|
+
- test
|
|
317
|
+
- review
|
|
318
|
+
- refactor
|
|
319
|
+
|
|
320
|
+
# Context providers
|
|
321
|
+
context:
|
|
322
|
+
include_config: true
|
|
323
|
+
include_features: true
|
|
324
|
+
include_standards: true
|
|
325
|
+
include_patterns: true
|
|
326
|
+
|
|
327
|
+
# Model preferences
|
|
328
|
+
models:
|
|
329
|
+
chat: "anthropic/claude-3-5-sonnet"
|
|
330
|
+
autocomplete: "mistral/codestral"
|
|
331
|
+
|
|
332
|
+
# System message customization
|
|
333
|
+
include_in_system:
|
|
334
|
+
- project_overview
|
|
335
|
+
- coding_standards
|
|
336
|
+
- patterns
|
|
337
|
+
```
|
|
338
|
+
|
|
339
|
+
---
|
|
340
|
+
|
|
341
|
+
## Syncing Configuration
|
|
342
|
+
|
|
343
|
+
```bash
|
|
344
|
+
# Generate Continue config
|
|
345
|
+
proagents ide generate continue
|
|
346
|
+
|
|
347
|
+
# Include all context
|
|
348
|
+
proagents ide generate continue --full
|
|
349
|
+
|
|
350
|
+
# Sync after changes
|
|
351
|
+
proagents ide sync continue
|
|
352
|
+
|
|
353
|
+
# Validate configuration
|
|
354
|
+
proagents ide validate continue
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
---
|
|
358
|
+
|
|
359
|
+
## VS Code Settings
|
|
360
|
+
|
|
361
|
+
Add to `.vscode/settings.json`:
|
|
362
|
+
|
|
363
|
+
```json
|
|
364
|
+
{
|
|
365
|
+
"continue.enableTabAutocomplete": true,
|
|
366
|
+
"continue.showInlineTip": true,
|
|
367
|
+
"continue.remoteConfigServerUrl": null,
|
|
368
|
+
"continue.customConfigPath": ".continuerc.json"
|
|
369
|
+
}
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
---
|
|
373
|
+
|
|
374
|
+
## Best Practices
|
|
375
|
+
|
|
376
|
+
1. **Model Selection**: Use appropriate models for different tasks
|
|
377
|
+
2. **Context Management**: Configure context providers for relevant information
|
|
378
|
+
3. **Custom Commands**: Create commands for common workflows
|
|
379
|
+
4. **System Message**: Keep it concise but comprehensive
|
|
380
|
+
5. **Regular Updates**: Sync config when project evolves
|
|
@@ -0,0 +1,280 @@
|
|
|
1
|
+
# Cursor Rules Configuration
|
|
2
|
+
|
|
3
|
+
Configure Cursor IDE to work with ProAgents workflow.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
Cursor uses a `.cursorrules` file in the project root to provide context and instructions to its AI assistant.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Quick Setup
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# Generate Cursor rules from ProAgents config
|
|
17
|
+
proagents ide generate cursor
|
|
18
|
+
|
|
19
|
+
# This creates .cursorrules in your project root
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Complete .cursorrules Template
|
|
25
|
+
|
|
26
|
+
Create `.cursorrules` in your project root:
|
|
27
|
+
|
|
28
|
+
```markdown
|
|
29
|
+
# ProAgents Development Workflow
|
|
30
|
+
|
|
31
|
+
You are an AI assistant integrated with the ProAgents development workflow. Follow these guidelines for all development tasks.
|
|
32
|
+
|
|
33
|
+
## Workflow Commands
|
|
34
|
+
|
|
35
|
+
When the user types a slash command, follow the corresponding workflow:
|
|
36
|
+
|
|
37
|
+
- `/init` - Initialize ProAgents in this project
|
|
38
|
+
- `/feature <name>` - Start a new feature with full workflow
|
|
39
|
+
- `/fix <description>` - Start bug fix workflow
|
|
40
|
+
- `/doc` - Generate documentation
|
|
41
|
+
- `/test` - Run tests
|
|
42
|
+
- `/qa` - Quality assurance checks
|
|
43
|
+
- `/deploy` - Deployment workflow
|
|
44
|
+
- `/status` - Show current workflow status
|
|
45
|
+
|
|
46
|
+
## Development Phases
|
|
47
|
+
|
|
48
|
+
For new features, follow these phases in order:
|
|
49
|
+
|
|
50
|
+
1. **Analysis** - Understand existing codebase patterns
|
|
51
|
+
2. **Requirements** - Clarify feature requirements
|
|
52
|
+
3. **Design** - Plan UI/architecture
|
|
53
|
+
4. **Planning** - Create implementation plan
|
|
54
|
+
5. **Implementation** - Write code following project patterns
|
|
55
|
+
6. **Testing** - Write comprehensive tests
|
|
56
|
+
7. **Review** - Self-review against checklist
|
|
57
|
+
8. **Documentation** - Document the feature
|
|
58
|
+
|
|
59
|
+
## Code Standards
|
|
60
|
+
|
|
61
|
+
### TypeScript/JavaScript
|
|
62
|
+
- Use TypeScript strict mode
|
|
63
|
+
- Prefer functional components
|
|
64
|
+
- Use named exports
|
|
65
|
+
- Follow existing naming conventions
|
|
66
|
+
|
|
67
|
+
### File Naming
|
|
68
|
+
- Components: PascalCase (e.g., `UserProfile.tsx`)
|
|
69
|
+
- Utilities: kebab-case (e.g., `string-utils.ts`)
|
|
70
|
+
- Tests: `{name}.test.ts`
|
|
71
|
+
|
|
72
|
+
### Imports
|
|
73
|
+
- Use absolute imports with `@/` prefix
|
|
74
|
+
- Order: React → Third-party → Local → Styles
|
|
75
|
+
|
|
76
|
+
## Project Patterns
|
|
77
|
+
|
|
78
|
+
### State Management
|
|
79
|
+
- Use Zustand for global state
|
|
80
|
+
- Use React hooks for local state
|
|
81
|
+
- Use React Query for server state
|
|
82
|
+
|
|
83
|
+
### Styling
|
|
84
|
+
- Use Tailwind CSS utility classes
|
|
85
|
+
- Follow mobile-first responsive design
|
|
86
|
+
|
|
87
|
+
### Error Handling
|
|
88
|
+
- Use try-catch for async operations
|
|
89
|
+
- Use Error Boundaries for components
|
|
90
|
+
- Log errors with proper context
|
|
91
|
+
|
|
92
|
+
### Testing
|
|
93
|
+
- Write unit tests for utilities and hooks
|
|
94
|
+
- Write integration tests for components
|
|
95
|
+
- Aim for 80% coverage on new code
|
|
96
|
+
|
|
97
|
+
## Before Writing Code
|
|
98
|
+
|
|
99
|
+
Always:
|
|
100
|
+
1. Check existing patterns in the codebase
|
|
101
|
+
2. Look for similar implementations to follow
|
|
102
|
+
3. Verify the approach aligns with project architecture
|
|
103
|
+
4. Consider edge cases and error handling
|
|
104
|
+
|
|
105
|
+
## Code Quality Checklist
|
|
106
|
+
|
|
107
|
+
Before completing any implementation:
|
|
108
|
+
- [ ] Code follows project conventions
|
|
109
|
+
- [ ] No TypeScript errors
|
|
110
|
+
- [ ] Tests written and passing
|
|
111
|
+
- [ ] Error handling implemented
|
|
112
|
+
- [ ] No hardcoded values
|
|
113
|
+
- [ ] Accessible (ARIA labels, keyboard nav)
|
|
114
|
+
|
|
115
|
+
## Communication
|
|
116
|
+
|
|
117
|
+
- Explain your reasoning before making changes
|
|
118
|
+
- Ask clarifying questions if requirements are unclear
|
|
119
|
+
- Suggest alternatives when appropriate
|
|
120
|
+
- Warn about potential breaking changes
|
|
121
|
+
|
|
122
|
+
## File Locations
|
|
123
|
+
|
|
124
|
+
- Components: `src/components/`
|
|
125
|
+
- Pages: `src/pages/` or `src/app/`
|
|
126
|
+
- Hooks: `src/hooks/`
|
|
127
|
+
- Utils: `src/utils/` or `src/lib/`
|
|
128
|
+
- Types: `src/types/`
|
|
129
|
+
- Tests: `__tests__/` or colocated with source
|
|
130
|
+
|
|
131
|
+
## Don't
|
|
132
|
+
|
|
133
|
+
- Don't create files outside the project structure
|
|
134
|
+
- Don't modify configuration files without asking
|
|
135
|
+
- Don't remove existing functionality without confirmation
|
|
136
|
+
- Don't skip tests for "simple" changes
|
|
137
|
+
- Don't use deprecated APIs or patterns
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
---
|
|
141
|
+
|
|
142
|
+
## Dynamic Rules Generation
|
|
143
|
+
|
|
144
|
+
ProAgents can generate rules based on your project analysis:
|
|
145
|
+
|
|
146
|
+
```bash
|
|
147
|
+
# Generate with detected patterns
|
|
148
|
+
proagents ide generate cursor --include-patterns
|
|
149
|
+
|
|
150
|
+
# Generate with learned preferences
|
|
151
|
+
proagents ide generate cursor --include-learning
|
|
152
|
+
|
|
153
|
+
# Full generation with everything
|
|
154
|
+
proagents ide generate cursor --full
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
## Project-Specific Additions
|
|
160
|
+
|
|
161
|
+
Add to `.cursorrules` based on your project:
|
|
162
|
+
|
|
163
|
+
### For React Projects
|
|
164
|
+
```markdown
|
|
165
|
+
## React Patterns
|
|
166
|
+
|
|
167
|
+
- Use functional components exclusively
|
|
168
|
+
- Implement React.memo for expensive renders
|
|
169
|
+
- Use useCallback for event handlers passed to children
|
|
170
|
+
- Use useMemo for expensive calculations
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
### For Next.js Projects
|
|
174
|
+
```markdown
|
|
175
|
+
## Next.js Patterns
|
|
176
|
+
|
|
177
|
+
- Use App Router conventions
|
|
178
|
+
- Implement loading.tsx for suspense boundaries
|
|
179
|
+
- Use server components by default
|
|
180
|
+
- Client components only when needed (use 'use client')
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
### For API Projects
|
|
184
|
+
```markdown
|
|
185
|
+
## API Patterns
|
|
186
|
+
|
|
187
|
+
- Use controller → service → repository pattern
|
|
188
|
+
- Validate all inputs with Zod/Joi
|
|
189
|
+
- Return consistent error responses
|
|
190
|
+
- Document endpoints with JSDoc
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
---
|
|
194
|
+
|
|
195
|
+
## Cursor-Specific Features
|
|
196
|
+
|
|
197
|
+
### Composer Mode
|
|
198
|
+
```markdown
|
|
199
|
+
## Composer Guidelines
|
|
200
|
+
|
|
201
|
+
When using Cursor Composer:
|
|
202
|
+
- Create files in correct locations
|
|
203
|
+
- Follow import conventions
|
|
204
|
+
- Include all necessary dependencies
|
|
205
|
+
- Add appropriate tests
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Chat Mode
|
|
209
|
+
```markdown
|
|
210
|
+
## Chat Guidelines
|
|
211
|
+
|
|
212
|
+
When answering questions:
|
|
213
|
+
- Reference specific files when relevant
|
|
214
|
+
- Provide code snippets with context
|
|
215
|
+
- Explain trade-offs of different approaches
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
---
|
|
219
|
+
|
|
220
|
+
## Syncing with ProAgents Config
|
|
221
|
+
|
|
222
|
+
```yaml
|
|
223
|
+
# proagents.config.yaml
|
|
224
|
+
ide:
|
|
225
|
+
cursor:
|
|
226
|
+
enabled: true
|
|
227
|
+
|
|
228
|
+
# Sections to include
|
|
229
|
+
include:
|
|
230
|
+
- workflow_commands
|
|
231
|
+
- code_standards
|
|
232
|
+
- project_patterns
|
|
233
|
+
- checklists
|
|
234
|
+
|
|
235
|
+
# Custom additions
|
|
236
|
+
custom_sections:
|
|
237
|
+
- name: "API Guidelines"
|
|
238
|
+
content: |
|
|
239
|
+
- All API calls go through /src/api/
|
|
240
|
+
- Use React Query for data fetching
|
|
241
|
+
- Handle loading and error states
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
---
|
|
245
|
+
|
|
246
|
+
## Updating Rules
|
|
247
|
+
|
|
248
|
+
When your project evolves:
|
|
249
|
+
|
|
250
|
+
```bash
|
|
251
|
+
# Regenerate rules after config changes
|
|
252
|
+
proagents ide sync cursor
|
|
253
|
+
|
|
254
|
+
# Diff current rules with generated
|
|
255
|
+
proagents ide diff cursor
|
|
256
|
+
|
|
257
|
+
# Backup and update
|
|
258
|
+
proagents ide update cursor --backup
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
---
|
|
262
|
+
|
|
263
|
+
## Troubleshooting
|
|
264
|
+
|
|
265
|
+
| Issue | Solution |
|
|
266
|
+
|-------|----------|
|
|
267
|
+
| Rules not loading | Restart Cursor IDE |
|
|
268
|
+
| Rules too long | Use `--compact` flag |
|
|
269
|
+
| Missing patterns | Run `proagents analyze` first |
|
|
270
|
+
| Conflicts with manual rules | Use `include` blocks |
|
|
271
|
+
|
|
272
|
+
---
|
|
273
|
+
|
|
274
|
+
## Best Practices
|
|
275
|
+
|
|
276
|
+
1. **Keep Rules Focused**: Don't overload with too many instructions
|
|
277
|
+
2. **Update Regularly**: Sync rules when project patterns change
|
|
278
|
+
3. **Test Rules**: Verify AI follows rules correctly
|
|
279
|
+
4. **Version Control**: Commit `.cursorrules` with your project
|
|
280
|
+
5. **Team Alignment**: Ensure all team members use same rules
|