proagents 1.0.0 → 1.0.2

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.
Files changed (149) hide show
  1. package/README.md +12 -12
  2. package/lib/commands/init.js +122 -11
  3. package/package.json +1 -1
  4. package/proagents/PROAGENTS.md +54 -0
  5. package/proagents/README.md +17 -17
  6. package/proagents/WORKFLOW.md +110 -110
  7. package/proagents/active-features/README.md +9 -9
  8. package/proagents/adr/README.md +15 -15
  9. package/proagents/api-versioning/changelog-template.md +4 -4
  10. package/proagents/api-versioning/deprecation-workflow.md +6 -6
  11. package/proagents/api-versioning/versioning-strategy.md +5 -5
  12. package/proagents/automation/ai-behavior-rules.md +1 -1
  13. package/proagents/automation/auto-decisions.md +6 -6
  14. package/proagents/cache/README.md +1 -1
  15. package/proagents/changelog/README.md +16 -16
  16. package/proagents/changelog/entry-template.md +4 -4
  17. package/proagents/cli/README.md +1 -1
  18. package/proagents/cli/slash-commands.md +202 -202
  19. package/proagents/collaboration/sessions.md +6 -6
  20. package/proagents/config/integrations/README.md +1 -1
  21. package/proagents/contract-testing/README.md +5 -5
  22. package/proagents/contract-testing/schema-validation.md +6 -6
  23. package/proagents/cost/cost-template.md +6 -6
  24. package/proagents/cost/estimation-framework.md +5 -5
  25. package/proagents/database/migration-workflow.md +6 -6
  26. package/proagents/database/rollback-scripts.md +6 -6
  27. package/proagents/database/safety-checks.md +6 -6
  28. package/proagents/examples/backend-nodejs/workflow-example.md +1 -1
  29. package/proagents/examples/web-frontend-react/workflow-example.md +1 -1
  30. package/proagents/existing-projects/README.md +3 -3
  31. package/proagents/existing-projects/challenges.md +1 -1
  32. package/proagents/existing-projects/coexistence-mode.md +8 -8
  33. package/proagents/existing-projects/compatibility-assessment.md +12 -12
  34. package/proagents/existing-projects/gradual-adoption.md +14 -14
  35. package/proagents/existing-projects/migration-strategies.md +7 -7
  36. package/proagents/existing-projects/pattern-reconciliation.md +10 -10
  37. package/proagents/existing-projects/team-onboarding.md +23 -23
  38. package/proagents/existing-projects/technical-debt-handling.md +24 -24
  39. package/proagents/getting-started/README.md +3 -3
  40. package/proagents/getting-started/ai-training-setup.md +24 -24
  41. package/proagents/getting-started/pm-integration.md +22 -22
  42. package/proagents/getting-started/prompt-engineering.md +4 -4
  43. package/proagents/getting-started/team-onboarding.md +5 -5
  44. package/proagents/git/branch-strategy.md +10 -10
  45. package/proagents/git/commit-conventions.md +5 -5
  46. package/proagents/git/pr-workflow.md +5 -5
  47. package/proagents/git/rollback-procedures.md +7 -7
  48. package/proagents/ide-integration/README.md +1 -1
  49. package/proagents/ide-integration/cline-config.md +10 -10
  50. package/proagents/ide-integration/continue-config.md +1 -1
  51. package/proagents/ide-integration/cursor-rules.md +10 -10
  52. package/proagents/ide-integration/github-copilot.md +4 -4
  53. package/proagents/ide-integration/windsurf-rules.md +9 -9
  54. package/proagents/learning/adaptation.md +10 -10
  55. package/proagents/learning/data-collection.md +9 -9
  56. package/proagents/learning/reports.md +14 -14
  57. package/proagents/metrics/README.md +6 -6
  58. package/proagents/metrics/code-quality-kpis.md +6 -6
  59. package/proagents/metrics/deployment-metrics.md +6 -6
  60. package/proagents/metrics/developer-productivity.md +5 -5
  61. package/proagents/metrics/learning-effectiveness.md +6 -6
  62. package/proagents/migrations/from-claude-projects.md +7 -6
  63. package/proagents/migrations/from-cursor-rules.md +1 -1
  64. package/proagents/notifications/templates.md +3 -3
  65. package/proagents/parallel-features/README.md +5 -5
  66. package/proagents/parallel-features/conflict-detection.md +6 -6
  67. package/proagents/parallel-features/dependency-management.md +7 -7
  68. package/proagents/parallel-features/merge-coordination.md +8 -8
  69. package/proagents/parallel-features/tracking-system.md +7 -7
  70. package/proagents/performance/bundle-analysis.md +4 -4
  71. package/proagents/performance/load-testing.md +7 -7
  72. package/proagents/performance/runtime-metrics.md +6 -6
  73. package/proagents/performance/web-vitals.md +6 -6
  74. package/proagents/plugins/README.md +1 -1
  75. package/proagents/plugins/creating-plugins.md +1 -1
  76. package/proagents/plugins/plugin-api.md +2 -2
  77. package/proagents/plugins/plugin-registry.md +3 -3
  78. package/proagents/proagents.config.yaml +32 -9
  79. package/proagents/prompts/00-init-wizard.md +18 -18
  80. package/proagents/prompts/00-init.md +93 -93
  81. package/proagents/prompts/01-analysis.md +5 -5
  82. package/proagents/prompts/02-requirements.md +8 -8
  83. package/proagents/prompts/03-ui-design.md +14 -14
  84. package/proagents/prompts/04-planning.md +10 -10
  85. package/proagents/prompts/05-implementation.md +10 -10
  86. package/proagents/prompts/06-testing.md +14 -14
  87. package/proagents/prompts/06.5-code-review.md +8 -8
  88. package/proagents/prompts/07-documentation.md +142 -20
  89. package/proagents/prompts/08-deployment.md +12 -12
  90. package/proagents/prompts/09-rollback.md +12 -12
  91. package/proagents/prompts/README.md +4 -4
  92. package/proagents/prompts/accessibility/README.md +6 -6
  93. package/proagents/prompts/accessibility/audit.md +3 -3
  94. package/proagents/prompts/accessibility/wcag.md +1 -1
  95. package/proagents/prompts/debugging/README.md +4 -4
  96. package/proagents/prompts/debugging/performance-debug.md +5 -5
  97. package/proagents/prompts/debugging/systematic.md +4 -4
  98. package/proagents/prompts/performance/README.md +4 -4
  99. package/proagents/prompts/performance/analyze.md +4 -4
  100. package/proagents/prompts/refactoring/README.md +4 -4
  101. package/proagents/prompts/refactoring/code-smells.md +9 -9
  102. package/proagents/prompts/refactoring/patterns.md +6 -6
  103. package/proagents/prompts/security-audit/README.md +6 -6
  104. package/proagents/prompts/security-audit/code-review.md +5 -5
  105. package/proagents/reverse-engineering/README.md +21 -21
  106. package/proagents/reverse-engineering/architecture-extraction.md +6 -6
  107. package/proagents/reverse-engineering/code-analysis.md +6 -6
  108. package/proagents/reverse-engineering/dependency-mapping.md +10 -10
  109. package/proagents/reverse-engineering/diagram-generation.md +9 -9
  110. package/proagents/reverse-engineering/documentation-generation.md +7 -7
  111. package/proagents/reverse-engineering/pattern-detection.md +8 -8
  112. package/proagents/reverse-engineering/quality-assessment.md +10 -10
  113. package/proagents/rules/README.md +7 -7
  114. package/proagents/rules/custom-rules.md +8 -8
  115. package/proagents/runbooks/README.md +9 -9
  116. package/proagents/runbooks/dependency-vulnerability.md +4 -4
  117. package/proagents/runbooks/incident-response.md +12 -12
  118. package/proagents/runbooks/performance-degradation.md +5 -5
  119. package/proagents/runbooks/production-debugging.md +5 -5
  120. package/proagents/scaffolding/nextjs/README.md +10 -10
  121. package/proagents/scaffolding/nodejs/README.md +10 -10
  122. package/proagents/scaffolding/project-types.md +7 -7
  123. package/proagents/scaffolding/react/README.md +6 -6
  124. package/proagents/scaffolding/react-native/README.md +10 -10
  125. package/proagents/security/owasp-checklist.md +3 -3
  126. package/proagents/security/sast-guide.md +6 -6
  127. package/proagents/security/security-report-template.md +5 -5
  128. package/proagents/security/vulnerability-scanning.md +6 -6
  129. package/proagents/slash-commands.json +50 -75
  130. package/proagents/standards/README.md +4 -4
  131. package/proagents/standards/architecture-patterns.md +10 -10
  132. package/proagents/standards/naming-conventions-template.md +4 -4
  133. package/proagents/standards/override-system.md +8 -8
  134. package/proagents/team/code-ownership.md +4 -4
  135. package/proagents/team/communication-templates.md +6 -6
  136. package/proagents/team/handoff-protocol.md +4 -4
  137. package/proagents/team/ide-setup/cursor.md +1 -1
  138. package/proagents/templates/README.md +1 -1
  139. package/proagents/templates/release-notes.md +214 -0
  140. package/proagents/ui-integration/figma-guide.md +3 -3
  141. package/proagents/ui-integration/manual-export-guide.md +2 -2
  142. package/proagents/ui-integration/sketch-interpretation.md +2 -2
  143. package/proagents/webhooks/events.md +3 -3
  144. package/proagents/workflow-modes/README.md +11 -11
  145. package/proagents/workflow-modes/deferred-tracking.md +12 -12
  146. package/proagents/workflow-modes/entry-modes.md +16 -16
  147. package/proagents/workflow-modes/guardrails.md +7 -7
  148. package/proagents/workflow-modes/mode-detection.md +7 -7
  149. package/proagents/workflow-modes/mode-switching.md +9 -9
@@ -1,146 +1,122 @@
1
1
  {
2
2
  "version": "1.0.0",
3
+ "prefix": "pa:",
3
4
  "commands": [
4
5
  {
5
- "name": "/init",
6
+ "name": "pa:init",
6
7
  "description": "Initialize ProAgents in this project",
7
8
  "hints": [],
8
9
  "category": "setup"
9
10
  },
10
11
  {
11
- "name": "/feature",
12
- "description": "Feature development commands",
13
- "hints": ["/feature-start", "/feature-status", "/feature-pause", "/feature-resume", "/feature-complete", "/feature-list"],
14
- "category": "feature"
15
- },
16
- {
17
- "name": "/feature-start",
12
+ "name": "pa:feature",
18
13
  "description": "Start a new feature",
19
14
  "arguments": ["feature_name"],
15
+ "hints": ["pa:feature-status", "pa:feature-pause", "pa:feature-resume", "pa:feature-complete", "pa:feature-list"],
20
16
  "category": "feature"
21
17
  },
22
18
  {
23
- "name": "/feature-status",
19
+ "name": "pa:feature-status",
24
20
  "description": "Check current feature status",
25
21
  "category": "feature"
26
22
  },
27
23
  {
28
- "name": "/fix",
29
- "description": "Bug fix commands",
30
- "hints": ["/fix-quick", "/hotfix", "/fix-upgrade"],
24
+ "name": "pa:fix",
25
+ "description": "Quick bug fix mode",
26
+ "arguments": ["bug_description"],
27
+ "hints": ["pa:hotfix"],
31
28
  "category": "fix"
32
29
  },
33
30
  {
34
- "name": "/fix-quick",
35
- "description": "Quick bug fix mode",
31
+ "name": "pa:hotfix",
32
+ "description": "Emergency hotfix",
36
33
  "arguments": ["bug_description"],
37
34
  "category": "fix"
38
35
  },
39
36
  {
40
- "name": "/qa",
41
- "description": "Quality assurance commands",
42
- "hints": ["/qa-full", "/qa-quick", "/qa-security", "/qa-perf"],
37
+ "name": "pa:qa",
38
+ "description": "Quality assurance check",
39
+ "hints": ["pa:qa-full", "pa:qa-quick", "pa:qa-security", "pa:qa-perf"],
43
40
  "category": "qa"
44
41
  },
45
42
  {
46
- "name": "/test",
47
- "description": "Testing commands",
48
- "hints": ["/test-unit", "/test-integration", "/test-e2e", "/test-all"],
43
+ "name": "pa:test",
44
+ "description": "Run or create tests",
45
+ "hints": ["pa:test-unit", "pa:test-integration", "pa:test-e2e", "pa:test-all"],
49
46
  "category": "test"
50
47
  },
51
48
  {
52
- "name": "/doc",
53
- "description": "Documentation commands",
54
- "hints": ["/doc-full", "/doc-moderate", "/doc-lite", "/doc-module", "/doc-file", "/doc-api"],
55
- "category": "doc"
56
- },
57
- {
58
- "name": "/doc-full",
59
- "description": "Full in-depth documentation",
49
+ "name": "pa:doc",
50
+ "description": "Generate documentation",
51
+ "hints": ["pa:doc-full", "pa:doc-moderate", "pa:doc-lite", "pa:doc-module", "pa:doc-file", "pa:doc-api"],
60
52
  "category": "doc"
61
53
  },
62
54
  {
63
- "name": "/doc-moderate",
64
- "description": "Balanced documentation",
55
+ "name": "pa:release",
56
+ "description": "Generate release notes",
57
+ "arguments": ["version"],
65
58
  "category": "doc"
66
59
  },
67
60
  {
68
- "name": "/doc-lite",
69
- "description": "Quick reference documentation",
61
+ "name": "pa:changelog",
62
+ "description": "Update changelog",
70
63
  "category": "doc"
71
64
  },
72
65
  {
73
- "name": "/doc-module",
74
- "description": "Document specific module",
75
- "arguments": ["module_name"],
76
- "category": "doc"
77
- },
78
- {
79
- "name": "/analyze",
80
- "description": "Codebase analysis commands",
81
- "hints": ["/analyze-full", "/analyze-moderate", "/analyze-lite", "/analyze-module", "/analyze-deps"],
66
+ "name": "pa:analyze",
67
+ "description": "Analyze codebase",
68
+ "hints": ["pa:analyze-full", "pa:analyze-moderate", "pa:analyze-lite", "pa:analyze-deps"],
82
69
  "category": "analyze"
83
70
  },
84
71
  {
85
- "name": "/commit",
86
- "description": "Git commit commands",
87
- "hints": ["/commit-feat", "/commit-fix", "/commit-docs", "/commit-refactor"],
72
+ "name": "pa:commit",
73
+ "description": "Git commit",
74
+ "hints": ["pa:commit-feat", "pa:commit-fix", "pa:commit-docs"],
88
75
  "category": "git"
89
76
  },
90
77
  {
91
- "name": "/branch",
92
- "description": "Git branch commands",
93
- "hints": ["/branch-feature", "/branch-hotfix", "/branch-release"],
78
+ "name": "pa:branch",
79
+ "description": "Git branch operations",
80
+ "hints": ["pa:branch-feature", "pa:branch-hotfix", "pa:branch-release"],
94
81
  "category": "git"
95
82
  },
96
83
  {
97
- "name": "/pr",
98
- "description": "Pull request commands",
99
- "hints": ["/pr-create", "/pr-update", "/pr-merge"],
84
+ "name": "pa:pr",
85
+ "description": "Pull request operations",
86
+ "hints": ["pa:pr-create", "pa:pr-update", "pa:pr-merge"],
100
87
  "category": "git"
101
88
  },
102
89
  {
103
- "name": "/deploy",
104
- "description": "Deployment commands",
105
- "hints": ["/deploy-staging", "/deploy-prod", "/deploy-check"],
90
+ "name": "pa:deploy",
91
+ "description": "Deployment operations",
92
+ "hints": ["pa:deploy-staging", "pa:deploy-prod", "pa:deploy-check"],
106
93
  "category": "deploy"
107
94
  },
108
95
  {
109
- "name": "/rollback",
110
- "description": "Rollback commands",
111
- "hints": ["/rollback-quick", "/rollback-full"],
96
+ "name": "pa:rollback",
97
+ "description": "Rollback operations",
98
+ "hints": ["pa:rollback-quick", "pa:rollback-full"],
112
99
  "category": "deploy"
113
100
  },
114
101
  {
115
- "name": "/report",
116
- "description": "Report commands",
117
- "hints": ["/report-velocity", "/report-quality", "/report-coverage", "/report-security"],
102
+ "name": "pa:report",
103
+ "description": "Generate reports",
104
+ "hints": ["pa:report-velocity", "pa:report-quality", "pa:report-coverage"],
118
105
  "category": "report"
119
106
  },
120
107
  {
121
- "name": "/collab",
122
- "description": "Collaboration commands",
123
- "hints": ["/collab-start", "/collab-join", "/collab-leave"],
124
- "category": "collab"
125
- },
126
- {
127
- "name": "/status",
108
+ "name": "pa:status",
128
109
  "description": "Show workflow status",
129
110
  "category": "utility"
130
111
  },
131
112
  {
132
- "name": "/help",
113
+ "name": "pa:help",
133
114
  "description": "Show all commands",
134
115
  "category": "utility"
135
116
  },
136
117
  {
137
- "name": "/config",
138
- "description": "Configuration commands",
139
- "category": "utility"
140
- },
141
- {
142
- "name": "/doctor",
143
- "description": "Run health check",
118
+ "name": "pa:config",
119
+ "description": "Configuration settings",
144
120
  "category": "utility"
145
121
  }
146
122
  ],
@@ -155,7 +131,6 @@
155
131
  "git": "Git & Commits",
156
132
  "deploy": "Deployment",
157
133
  "report": "Reports",
158
- "collab": "Collaboration",
159
134
  "utility": "Utilities"
160
135
  }
161
136
  }
@@ -111,10 +111,10 @@ overrides:
111
111
 
112
112
  ---
113
113
 
114
- ## Slash Commands
114
+ ## Commands
115
115
 
116
116
  | Command | Description |
117
117
  |---------|-------------|
118
- | `/standards-check` | Check code against standards |
119
- | `/standards-view` | View current standards |
120
- | `/standards-update` | Update standards from template |
118
+ | `pa:standards-check` | Check code against standards |
119
+ | `pa:standards-view` | View current standards |
120
+ | `pa:standards-update` | Update standards from template |
@@ -643,7 +643,7 @@ validation:
643
643
 
644
644
  ```bash
645
645
  # Create a new feature following patterns
646
- /scaffold feature user-profile
646
+ pa:scaffold feature user-profile
647
647
 
648
648
  # Output:
649
649
  Created feature 'user-profile' at src/features/user-profile/
@@ -663,7 +663,7 @@ Created feature 'user-profile' at src/features/user-profile/
663
663
  scaffolding:
664
664
  templates:
665
665
  feature:
666
- command: "/scaffold feature {name}"
666
+ command: "pa:scaffold feature {name}"
667
667
  structure:
668
668
  - path: "index.ts"
669
669
  template: "templates/feature-index.ts"
@@ -675,7 +675,7 @@ scaffolding:
675
675
  storeName: "{Name}Store"
676
676
 
677
677
  component:
678
- command: "/scaffold component {name} --type {type}"
678
+ command: "pa:scaffold component {name} --type {type}"
679
679
  variants:
680
680
  page:
681
681
  structure: "component_patterns.page.structure"
@@ -716,13 +716,13 @@ architecture:
716
716
 
717
717
  ---
718
718
 
719
- ## Slash Commands
719
+ ## Commands
720
720
 
721
721
  | Command | Description |
722
722
  |---------|-------------|
723
- | `/architecture-check` | Validate architecture compliance |
724
- | `/architecture-view` | View current architecture |
725
- | `/architecture-diagram` | Generate architecture diagram |
726
- | `/scaffold [type] [name]` | Generate from patterns |
727
- | `/import-check` | Check import rules |
728
- | `/structure-check` | Check directory structure |
723
+ | `pa:architecture-check` | Validate architecture compliance |
724
+ | `pa:architecture-view` | View current architecture |
725
+ | `pa:architecture-diagram` | Generate architecture diagram |
726
+ | `pa:scaffold [type] [name]` | Generate from patterns |
727
+ | `pa:import-check` | Check import rules |
728
+ | `pa:structure-check` | Check directory structure |
@@ -517,10 +517,10 @@ naming_conventions:
517
517
 
518
518
  ---
519
519
 
520
- ## Slash Commands
520
+ ## Commands
521
521
 
522
522
  | Command | Description |
523
523
  |---------|-------------|
524
- | `/naming-check` | Check naming conventions |
525
- | `/naming-fix` | Auto-fix naming issues |
526
- | `/naming-guide` | Show naming guide |
524
+ | `pa:naming-check` | Check naming conventions |
525
+ | `pa:naming-fix` | Auto-fix naming issues |
526
+ | `pa:naming-guide` | Show naming guide |
@@ -547,7 +547,7 @@ locked:
547
547
 
548
548
  ```bash
549
549
  # Validate configuration
550
- /config validate
550
+ pa:config validate
551
551
 
552
552
  # Output:
553
553
  Configuration Validation
@@ -705,13 +705,13 @@ override_system:
705
705
 
706
706
  ---
707
707
 
708
- ## Slash Commands
708
+ ## Commands
709
709
 
710
710
  | Command | Description |
711
711
  |---------|-------------|
712
- | `/config view` | View current configuration |
713
- | `/config validate` | Validate configuration |
714
- | `/config overrides` | Show active overrides |
715
- | `/config diff` | Compare with defaults |
716
- | `/config export` | Export current config |
717
- | `/config reset [section]` | Reset to defaults |
712
+ | `pa:config view` | View current configuration |
713
+ | `pa:config validate` | Validate configuration |
714
+ | `pa:config overrides` | Show active overrides |
715
+ | `pa:config diff` | Compare with defaults |
716
+ | `pa:config export` | Export current config |
717
+ | `pa:config reset [section]` | Reset to defaults |
@@ -297,10 +297,10 @@ ownership:
297
297
 
298
298
  ---
299
299
 
300
- ## Slash Commands
300
+ ## Commands
301
301
 
302
302
  | Command | Description |
303
303
  |---------|-------------|
304
- | `/owner [path]` | Show owner for path |
305
- | `/ownership-report` | Generate ownership report |
306
- | `/assign-owner` | Assign ownership |
304
+ | `pa:owner [path]` | Show owner for path |
305
+ | `pa:ownership-report` | Generate ownership report |
306
+ | `pa:assign-owner` | Assign ownership |
@@ -430,12 +430,12 @@ cc: @team-lead
430
430
 
431
431
  ---
432
432
 
433
- ## Slash Commands
433
+ ## Commands
434
434
 
435
435
  | Command | Description |
436
436
  |---------|-------------|
437
- | `/notify-start` | Send feature start notification |
438
- | `/notify-update` | Send progress update |
439
- | `/notify-complete` | Send completion notification |
440
- | `/notify-deploy` | Send deployment notification |
441
- | `/handoff` | Generate handoff document |
437
+ | `pa:notify-start` | Send feature start notification |
438
+ | `pa:notify-update` | Send progress update |
439
+ | `pa:notify-complete` | Send completion notification |
440
+ | `pa:notify-deploy` | Send deployment notification |
441
+ | `pa:handoff` | Generate handoff document |
@@ -371,10 +371,10 @@ handoff:
371
371
 
372
372
  ---
373
373
 
374
- ## Slash Commands
374
+ ## Commands
375
375
 
376
376
  | Command | Description |
377
377
  |---------|-------------|
378
- | `/handoff-create` | Create handoff document |
379
- | `/handoff-emergency` | Quick emergency handoff |
380
- | `/handoff-checklist` | Show handoff checklist |
378
+ | `pa:handoff-create` | Create handoff document |
379
+ | `pa:handoff-emergency` | Quick emergency handoff |
380
+ | `pa:handoff-checklist` | Show handoff checklist |
@@ -66,7 +66,7 @@ Cursor's AI chat integrates well with ProAgents:
66
66
  ```
67
67
  # In Cursor Chat (Cmd+L)
68
68
 
69
- "Run /feature start 'Add user authentication'"
69
+ "Run pa:feature 'Add user authentication'"
70
70
 
71
71
  "Check the ProAgents workflow status"
72
72
 
@@ -18,7 +18,7 @@ Standardized templates for all workflow outputs ensuring consistency.
18
18
  | [Implementation Plan](./implementation-plan.md) | Planning | Task breakdown, architecture |
19
19
  | [Test Plan](./test-plan.md) | Testing | Test strategy and coverage |
20
20
  | [Code Review Report](./code-review-report.md) | Review | Review findings, suggestions |
21
- | [Feature Status](./feature-status.md) | Tracking | Progress and status updates |
21
+ | [Feature Status](.pa:feature-status.md) | Tracking | Progress and status updates |
22
22
  | [Deployment Checklist](./deployment-checklist.md) | Deployment | Pre-deploy verification |
23
23
  | [Rollback Plan](./rollback-plan.md) | Rollback | Recovery procedures |
24
24
 
@@ -0,0 +1,214 @@
1
+ # Release Notes Template
2
+
3
+ Use this template to generate client-facing release notes.
4
+
5
+ **Output Location:** `./RELEASE_NOTES.md` (project root)
6
+ **Archive Location:** `./docs/releases/v[VERSION].md`
7
+
8
+ ---
9
+
10
+ ## Template
11
+
12
+ ```markdown
13
+ # Release Notes - v[VERSION]
14
+
15
+ **Release Date:** [YYYY-MM-DD]
16
+ **Previous Version:** v[PREVIOUS_VERSION]
17
+
18
+ ---
19
+
20
+ ## Overview
21
+
22
+ [2-3 sentence executive summary describing this release. Focus on business value and user benefits, not technical details.]
23
+
24
+ ---
25
+
26
+ ## Highlights
27
+
28
+ | Feature | Description |
29
+ |---------|-------------|
30
+ | [Feature Name] | [One-line benefit] |
31
+ | [Feature Name] | [One-line benefit] |
32
+ | [Improvement] | [One-line benefit] |
33
+
34
+ ---
35
+
36
+ ## What's New
37
+
38
+ ### [Feature 1 Name]
39
+
40
+ [Client-friendly description: What it does, why it matters, how to use it]
41
+
42
+ **How to use:**
43
+ 1. [Step 1]
44
+ 2. [Step 2]
45
+
46
+ ### [Feature 2 Name]
47
+
48
+ [Client-friendly description]
49
+
50
+ ---
51
+
52
+ ## Improvements
53
+
54
+ - **[Area]:** [Improvement description and user benefit]
55
+ - **[Area]:** [Improvement description and user benefit]
56
+ - **Performance:** [Any performance improvements with metrics if available]
57
+
58
+ ---
59
+
60
+ ## Bug Fixes
61
+
62
+ - Fixed [issue in user-friendly terms]
63
+ - Resolved [issue in user-friendly terms]
64
+ - Corrected [issue in user-friendly terms]
65
+
66
+ ---
67
+
68
+ ## Breaking Changes
69
+
70
+ > **Important:** Please review these changes before upgrading.
71
+
72
+ ### [Breaking Change 1]
73
+
74
+ **What changed:** [Description]
75
+ **Why:** [Reason for the change]
76
+ **Action required:** [What users need to do]
77
+
78
+ ```
79
+ // Before
80
+ [old code/config]
81
+
82
+ // After
83
+ [new code/config]
84
+ ```
85
+
86
+ ---
87
+
88
+ ## Upgrade Instructions
89
+
90
+ ### From v[PREVIOUS_VERSION]
91
+
92
+ 1. [Step 1]
93
+ 2. [Step 2]
94
+ 3. [Step 3]
95
+
96
+ ### Migration Script (if applicable)
97
+
98
+ ```bash
99
+ # Run migration
100
+ [command]
101
+ ```
102
+
103
+ ---
104
+
105
+ ## Known Issues
106
+
107
+ | Issue | Workaround | Status |
108
+ |-------|------------|--------|
109
+ | [Issue description] | [Workaround] | Investigating |
110
+
111
+ ---
112
+
113
+ ## Coming Soon
114
+
115
+ Preview of features planned for upcoming releases:
116
+
117
+ - [Upcoming feature 1]
118
+ - [Upcoming feature 2]
119
+
120
+ ---
121
+
122
+ ## Resources
123
+
124
+ - [Full Changelog](./CHANGELOG.md)
125
+ - [Documentation](#)
126
+ - [Support](#)
127
+ - [Feedback](#)
128
+
129
+ ---
130
+
131
+ ## Thank You
132
+
133
+ Thank you to everyone who contributed to this release!
134
+
135
+ [Optional: List contributors or community acknowledgments]
136
+ ```
137
+
138
+ ---
139
+
140
+ ## Quick Release Notes (Lite Version)
141
+
142
+ For minor releases or quick updates:
143
+
144
+ ```markdown
145
+ # v[VERSION] Release Notes
146
+
147
+ **Date:** [YYYY-MM-DD]
148
+
149
+ ## Changes
150
+
151
+ - [Change 1]
152
+ - [Change 2]
153
+ - [Change 3]
154
+
155
+ ## Fixes
156
+
157
+ - [Fix 1]
158
+ - [Fix 2]
159
+
160
+ ---
161
+
162
+ See [CHANGELOG.md](./CHANGELOG.md) for full details.
163
+ ```
164
+
165
+ ---
166
+
167
+ ## Release Announcement Template
168
+
169
+ For email, Slack, or social media:
170
+
171
+ ```markdown
172
+ # [Product] v[VERSION] is here!
173
+
174
+ [One compelling sentence about the release]
175
+
176
+ ## Key Updates
177
+
178
+ - [Update 1] - [Benefit]
179
+ - [Update 2] - [Benefit]
180
+ - [Update 3] - [Benefit]
181
+
182
+ ## Get Started
183
+
184
+ [Link to release notes]
185
+ [Link to upgrade guide]
186
+ [Link to documentation]
187
+
188
+ Questions? [Contact/Support link]
189
+ ```
190
+
191
+ ---
192
+
193
+ ## Version Archive Structure
194
+
195
+ ```
196
+ docs/
197
+ └── releases/
198
+ ├── README.md # Release history index
199
+ ├── v1.0.0.md # Initial release
200
+ ├── v1.1.0.md # Feature release
201
+ ├── v1.1.1.md # Patch release
202
+ └── v2.0.0.md # Major release
203
+ ```
204
+
205
+ ---
206
+
207
+ ## Commands
208
+
209
+ | Command | Action |
210
+ |---------|--------|
211
+ | `pa:release` | Generate release notes for current version |
212
+ | `pa:doc-release [version]` | Generate notes for specific version |
213
+ | `pa:doc-release --announce` | Generate release announcement |
214
+ | `pa:doc-release --archive` | Archive current notes to docs/releases/ |
@@ -38,7 +38,7 @@ integrations:
38
38
  ### Usage
39
39
 
40
40
  ```
41
- /design-figma "https://figma.com/file/xxx/Design"
41
+ pa:design-figma "https://figma.com/file/xxx/Design"
42
42
  ```
43
43
 
44
44
  ### What Gets Extracted
@@ -97,7 +97,7 @@ integrations:
97
97
  ### Usage
98
98
 
99
99
  ```
100
- /design-export
100
+ pa:design-export
101
101
 
102
102
  AI: "Please provide the exported design files."
103
103
  User: [Uploads images or provides paths]
@@ -124,7 +124,7 @@ Use Figma's native developer features:
124
124
  4. Provide to AI
125
125
 
126
126
  ```
127
- /design
127
+ pa:design
128
128
 
129
129
  User: "Here's the CSS from Figma Dev Mode:
130
130
  [paste CSS]"
@@ -139,7 +139,7 @@ Create a specs document with:
139
139
  ### Usage
140
140
 
141
141
  ```
142
- /design-export
142
+ pa:design-export
143
143
 
144
144
  AI: "Please provide the exported design files."
145
145
  User: [Provides file paths or uploads images]
@@ -350,7 +350,7 @@ exports/
350
350
 
351
351
  ```
352
352
  1. Export designs from your tool
353
- 2. Run: /design-export
353
+ 2. Run: pa:design-export
354
354
  3. Provide exported files
355
355
  4. Review AI analysis
356
356
  5. Confirm component mapping
@@ -103,7 +103,7 @@ Use these conventions for AI to better interpret your sketches:
103
103
  ### Usage
104
104
 
105
105
  ```
106
- /design-sketch
106
+ pa:design-sketch
107
107
 
108
108
  AI: "Please provide your sketch or wireframe."
109
109
  User: [Provides image path or uploads sketch]
@@ -462,7 +462,7 @@ AI Output:
462
462
  ```
463
463
  1. Create sketch (paper or digital)
464
464
  2. Photo/scan sketch
465
- 3. Run: /design-sketch
465
+ 3. Run: pa:design-sketch
466
466
  4. Provide sketch image
467
467
  5. Review AI interpretation
468
468
  6. Iterate and refine
@@ -10,9 +10,9 @@ Complete reference of all webhook events.
10
10
 
11
11
  | Event | Description | Trigger |
12
12
  |-------|-------------|---------|
13
- | `feature.started` | New feature started | `/feature start` |
14
- | `feature.paused` | Feature paused | `/feature pause` |
15
- | `feature.resumed` | Feature resumed | `/feature resume` |
13
+ | `feature.started` | New feature started | `pa:feature start` |
14
+ | `feature.paused` | Feature paused | `pa:feature pause` |
15
+ | `feature.resumed` | Feature resumed | `pa:feature resume` |
16
16
  | `feature.completed` | Feature completed | All phases done |
17
17
  | `feature.abandoned` | Feature abandoned | Manual cancellation |
18
18