amazingteam 3.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/.ai-team/agents/architect.md +144 -0
- package/.ai-team/agents/ci-analyst.md +188 -0
- package/.ai-team/agents/developer.md +176 -0
- package/.ai-team/agents/planner.md +355 -0
- package/.ai-team/agents/qa.md +189 -0
- package/.ai-team/agents/reviewer.md +211 -0
- package/.ai-team/agents/triage.md +146 -0
- package/.ai-team/commands/ci-analyze.md +116 -0
- package/.ai-team/commands/design.md +100 -0
- package/.ai-team/commands/implement.md +108 -0
- package/.ai-team/commands/release-check.md +142 -0
- package/.ai-team/commands/review.md +142 -0
- package/.ai-team/commands/test.md +115 -0
- package/.ai-team/commands/triage.md +138 -0
- package/.ai-team/memory/architect/architecture_notes.md +67 -0
- package/.ai-team/memory/architect/design_rationale.md +113 -0
- package/.ai-team/memory/architect/module_map.md +84 -0
- package/.ai-team/memory/ci-analyst/failure_patterns.md +102 -0
- package/.ai-team/memory/ci-analyst/runbook_references.md +87 -0
- package/.ai-team/memory/developer/bug_investigation.md +102 -0
- package/.ai-team/memory/developer/build_issues.md +115 -0
- package/.ai-team/memory/developer/implementation_notes.md +83 -0
- package/.ai-team/memory/failures/failure_library.md +103 -0
- package/.ai-team/memory/planner/decomposition_notes.md +82 -0
- package/.ai-team/memory/planner/flow_rules.md +86 -0
- package/.ai-team/memory/planner/github_issue_patterns.md +229 -0
- package/.ai-team/memory/qa/regression_cases.md +101 -0
- package/.ai-team/memory/qa/test_strategy.md +138 -0
- package/.ai-team/memory/qa/validation_notes.md +110 -0
- package/.ai-team/memory/reviewer/quality_rules.md +105 -0
- package/.ai-team/memory/reviewer/recurring_risks.md +109 -0
- package/.ai-team/memory/reviewer/review_notes.md +124 -0
- package/.ai-team/memory/triage/classification_heuristics.md +82 -0
- package/.ai-team/memory/triage/debug_notes.md +87 -0
- package/.ai-team/opencode.template.jsonc +216 -0
- package/.ai-team/skills/bugfix-playbook/skill.md +174 -0
- package/.ai-team/skills/ci-failure-analysis/skill.md +176 -0
- package/.ai-team/skills/issue-triage/skill.md +163 -0
- package/.ai-team/skills/regression-checklist/skill.md +176 -0
- package/.ai-team/skills/release-readiness-check/skill.md +216 -0
- package/.ai-team/skills/repo-architecture-reader/skill.md +139 -0
- package/.ai-team/skills/safe-refactor-checklist/skill.md +215 -0
- package/.ai-team/skills/task-breakdown-and-dispatch/skill.md +151 -0
- package/.ai-team/skills/test-first-feature-dev/skill.md +205 -0
- package/.ai-team/workflows/ci.yml +81 -0
- package/.ai-team/workflows/nightly-ai-maintenance.yml +129 -0
- package/.ai-team/workflows/opencode.yml +33 -0
- package/.ai-team/workflows/pr-check.yml +41 -0
- package/.foundation/foundation.lock +38 -0
- package/.foundation/local-overrides.md +97 -0
- package/.foundation/upgrade-history.md +38 -0
- package/.opencode/agents/architect.md +38 -0
- package/.opencode/agents/ci-analyst.md +38 -0
- package/.opencode/agents/developer.md +43 -0
- package/.opencode/agents/planner.md +47 -0
- package/.opencode/agents/qa.md +34 -0
- package/.opencode/agents/reviewer.md +38 -0
- package/.opencode/agents/triage.md +37 -0
- package/.opencode/commands/auto.md +264 -0
- package/.opencode/commands/breakdown-issue.md +94 -0
- package/.opencode/commands/ci-analyze.md +15 -0
- package/.opencode/commands/close-parent-task.md +122 -0
- package/.opencode/commands/design.md +15 -0
- package/.opencode/commands/dispatch-next.md +102 -0
- package/.opencode/commands/implement.md +16 -0
- package/.opencode/commands/release-check.md +16 -0
- package/.opencode/commands/resume.md +88 -0
- package/.opencode/commands/review.md +15 -0
- package/.opencode/commands/show-blockers.md +97 -0
- package/.opencode/commands/summarize-parent.md +121 -0
- package/.opencode/commands/test.md +15 -0
- package/.opencode/commands/triage.md +109 -0
- package/.opencode/skills/bugfix-playbook/SKILL.md +81 -0
- package/.opencode/skills/ci-failure-analysis/SKILL.md +94 -0
- package/.opencode/skills/issue-triage/SKILL.md +80 -0
- package/.opencode/skills/regression-checklist/SKILL.md +81 -0
- package/.opencode/skills/release-readiness-check/SKILL.md +81 -0
- package/.opencode/skills/repo-architecture-reader/SKILL.md +65 -0
- package/.opencode/skills/safe-refactor-checklist/SKILL.md +76 -0
- package/.opencode/skills/task-breakdown-and-dispatch/SKILL.md +255 -0
- package/.opencode/skills/test-first-feature-dev/SKILL.md +78 -0
- package/AGENTS.md +879 -0
- package/CHANGELOG.md +261 -0
- package/LICENSE +21 -0
- package/README.md +1215 -0
- package/VERSION +1 -0
- package/action/__tests__/downloader.test.js +251 -0
- package/action/__tests__/merger.test.js +156 -0
- package/action/__tests__/path-resolver.test.js +199 -0
- package/action/__tests__/validator.test.js +310 -0
- package/action/action.yml +61 -0
- package/action/index.js +223 -0
- package/action/lib/downloader.js +344 -0
- package/action/lib/merger.js +170 -0
- package/action/lib/path-resolver.js +176 -0
- package/action/lib/setup.js +286 -0
- package/action/lib/validator.js +324 -0
- package/cli/__tests__/cli.test.js +270 -0
- package/cli/amazingteam.cjs +225 -0
- package/cli/commands/check-update.cjs +159 -0
- package/cli/commands/init.cjs +412 -0
- package/cli/commands/local.cjs +264 -0
- package/cli/commands/migrate.cjs +316 -0
- package/cli/commands/status.cjs +241 -0
- package/cli/commands/upgrade.cjs +213 -0
- package/cli/commands/validate.cjs +259 -0
- package/cli/commands/version.cjs +59 -0
- package/cli/sync.cjs +237 -0
- package/dist/index.js +35 -0
- package/docs/architecture/overview.md +138 -0
- package/docs/blocker_resolution_design.md +372 -0
- package/docs/bootstrap-model.md +356 -0
- package/docs/config-reference.md +458 -0
- package/docs/how-to-use.md +178 -0
- package/docs/migration-to-v3.md +355 -0
- package/docs/overlay-guide.md +156 -0
- package/docs/patterns/README.md +67 -0
- package/docs/quick-start-v3.md +330 -0
- package/docs/releases/README.md +64 -0
- package/docs/runbooks/ci/README.md +62 -0
- package/docs/runbooks/ci/build-debug.md +120 -0
- package/docs/runbooks/ci/flaky-tests.md +127 -0
- package/docs/runbooks/getting-started.md +81 -0
- package/docs/upgrade-policy.md +188 -0
- package/docs/versioning.md +199 -0
- package/overlays/README.md +30 -0
- package/overlays/ai-agent-product/.ai-team/skills/llm-integration/skill.md +99 -0
- package/overlays/ai-agent-product/docs/ai-agent-architecture.md +68 -0
- package/overlays/ai-agent-product/overlay.yaml +26 -0
- package/overlays/cpp-qt-desktop/.ai-team/skills/qt-signals-slots/skill.md +60 -0
- package/overlays/cpp-qt-desktop/docs/qt-conventions.md +64 -0
- package/overlays/cpp-qt-desktop/overlay.yaml +22 -0
- package/overlays/python-backend/.ai-team/skills/python-testing/skill.md +90 -0
- package/overlays/python-backend/docs/python-style.md +78 -0
- package/overlays/python-backend/overlay.yaml +22 -0
- package/overlays/web-fullstack/.ai-team/skills/frontend-testing/skill.md +70 -0
- package/overlays/web-fullstack/docs/frontend-conventions.md +68 -0
- package/overlays/web-fullstack/overlay.yaml +26 -0
- package/package.json +84 -0
- package/presets/default.yaml +161 -0
- package/presets/go.yaml +43 -0
- package/presets/python.yaml +43 -0
- package/presets/typescript.yaml +40 -0
- package/schemas/config.schema.json +239 -0
- package/scripts/diff_foundation_vs_project.sh +134 -0
- package/scripts/generate_docs.sh +200 -0
- package/scripts/init_project.sh +455 -0
- package/scripts/plan_upgrade.sh +268 -0
- package/scripts/upgrade_foundation.sh +365 -0
- package/scripts/validate-foundation.cjs +278 -0
- package/scripts/validate_foundation.sh +192 -0
- package/scripts/validate_project_setup.sh +171 -0
- package/tasks/README.md +94 -0
- package/tasks/_template/analysis.md +76 -0
- package/tasks/_template/design.md +121 -0
- package/tasks/_template/implementation.md +121 -0
- package/tasks/_template/release.md +119 -0
- package/tasks/_template/review.md +131 -0
- package/tasks/_template/subtasks/task.yaml +24 -0
- package/tasks/_template/task.yaml +75 -0
- package/tasks/_template/validation.md +128 -0
- package/templates/amazingteam.yml +81 -0
- package/templates/gitignore +14 -0
- package/templates/opencode.jsonc +216 -0
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
# Issue Triage
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
This skill provides a systematic approach to classifying, prioritizing, and performing initial analysis on incoming issues.
|
|
6
|
+
|
|
7
|
+
## When to Use
|
|
8
|
+
|
|
9
|
+
- New issue created
|
|
10
|
+
- Bug report received
|
|
11
|
+
- Feature request submitted
|
|
12
|
+
- Starting work on untriaged issues
|
|
13
|
+
|
|
14
|
+
## Steps
|
|
15
|
+
|
|
16
|
+
### 1. Initial Classification
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
1. Read issue title and description
|
|
20
|
+
2. Classify issue type:
|
|
21
|
+
- bug: Something is broken
|
|
22
|
+
- feature: New functionality requested
|
|
23
|
+
- enhancement: Improvement to existing feature
|
|
24
|
+
- docs: Documentation issue
|
|
25
|
+
- tech: Technical debt or infrastructure
|
|
26
|
+
- question: Clarification needed
|
|
27
|
+
3. Assign priority:
|
|
28
|
+
- critical: Blocks production or security issue
|
|
29
|
+
- high: Major functionality impacted
|
|
30
|
+
- medium: Standard priority
|
|
31
|
+
- low: Nice to have
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### 2. Validation
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
1. Verify issue is reproducible
|
|
38
|
+
2. Check for duplicate issues
|
|
39
|
+
3. Validate user-provided information
|
|
40
|
+
4. Request missing information if needed
|
|
41
|
+
5. Add reproduction steps if missing
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### 3. Root Cause Investigation
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
1. Examine error messages and stack traces
|
|
48
|
+
2. Identify affected components
|
|
49
|
+
3. Review recent changes to affected areas
|
|
50
|
+
4. Check logs for related errors
|
|
51
|
+
5. Document findings
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### 4. Scope Assessment
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
1. Identify affected modules
|
|
58
|
+
2. Determine if fix requires:
|
|
59
|
+
- Single file change
|
|
60
|
+
- Multiple files
|
|
61
|
+
- Architectural change
|
|
62
|
+
- External dependency update
|
|
63
|
+
3. Assess risk level
|
|
64
|
+
4. Estimate effort (small/medium/large)
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### 5. Assignment Decision
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+
1. Determine appropriate owner:
|
|
71
|
+
- architect: Design needed
|
|
72
|
+
- developer: Implementation needed
|
|
73
|
+
- qa: Testing focus
|
|
74
|
+
- triage: More investigation needed
|
|
75
|
+
2. Add appropriate labels
|
|
76
|
+
3. Link related issues
|
|
77
|
+
4. Set milestone if applicable
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### 6. Documentation
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
1. Update issue with analysis
|
|
84
|
+
2. Add investigation notes
|
|
85
|
+
3. Document reproduction steps
|
|
86
|
+
4. Link to relevant code
|
|
87
|
+
5. Provide recommendation
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## Triage Report Template
|
|
91
|
+
|
|
92
|
+
```markdown
|
|
93
|
+
## Triage Analysis: [Issue Title]
|
|
94
|
+
|
|
95
|
+
### Classification
|
|
96
|
+
- **Type**: bug | feature | enhancement | docs | tech | question
|
|
97
|
+
- **Priority**: critical | high | medium | low
|
|
98
|
+
- **Risk Level**: low | medium | high
|
|
99
|
+
|
|
100
|
+
### Summary
|
|
101
|
+
[Brief summary of the issue]
|
|
102
|
+
|
|
103
|
+
### Root Cause Analysis
|
|
104
|
+
[Findings from investigation, if applicable]
|
|
105
|
+
|
|
106
|
+
### Affected Components
|
|
107
|
+
- `module/component` - [Impact description]
|
|
108
|
+
|
|
109
|
+
### Reproduction Steps
|
|
110
|
+
1. [Step 1]
|
|
111
|
+
2. [Step 2]
|
|
112
|
+
3. [Step 3]
|
|
113
|
+
|
|
114
|
+
### Expected Behavior
|
|
115
|
+
[What should happen]
|
|
116
|
+
|
|
117
|
+
### Actual Behavior
|
|
118
|
+
[What actually happens]
|
|
119
|
+
|
|
120
|
+
### Recommendation
|
|
121
|
+
- **Owner**: architect | developer | qa
|
|
122
|
+
- **Effort**: small | medium | large
|
|
123
|
+
- **Notes**: [Additional context]
|
|
124
|
+
|
|
125
|
+
### Related Issues
|
|
126
|
+
- #[issue number] - [description]
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## Classification Matrix
|
|
130
|
+
|
|
131
|
+
| Symptom | Likely Type | Likely Priority |
|
|
132
|
+
|---------|-------------|-----------------|
|
|
133
|
+
| Production down | bug | critical |
|
|
134
|
+
| Data loss | bug | critical |
|
|
135
|
+
| Security vulnerability | bug | critical |
|
|
136
|
+
| Feature not working | bug | high |
|
|
137
|
+
| Performance degradation | bug | medium |
|
|
138
|
+
| UI glitch | bug | low |
|
|
139
|
+
| New capability needed | feature | medium |
|
|
140
|
+
| Improvement request | enhancement | low |
|
|
141
|
+
| Missing documentation | docs | low |
|
|
142
|
+
|
|
143
|
+
## Checklist
|
|
144
|
+
|
|
145
|
+
- [ ] Issue type classified
|
|
146
|
+
- [ ] Priority assigned
|
|
147
|
+
- [ ] Duplicates checked
|
|
148
|
+
- [ ] Reproduction steps verified
|
|
149
|
+
- [ ] Root cause investigated
|
|
150
|
+
- [ ] Scope assessed
|
|
151
|
+
- [ ] Owner assigned
|
|
152
|
+
- [ ] Labels added
|
|
153
|
+
- [ ] Documentation complete
|
|
154
|
+
|
|
155
|
+
## Best Practices
|
|
156
|
+
|
|
157
|
+
- Always verify before assigning priority
|
|
158
|
+
- Request more info rather than guessing
|
|
159
|
+
- Check recent commits for context
|
|
160
|
+
- Link related issues
|
|
161
|
+
- Document even negative findings
|
|
162
|
+
- Update issue status promptly
|
|
163
|
+
- Follow up on blocked issues
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
# Regression Checklist
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
This skill ensures comprehensive regression testing and prevents unintended side effects from code changes.
|
|
6
|
+
|
|
7
|
+
## When to Use
|
|
8
|
+
|
|
9
|
+
- Before merging a PR
|
|
10
|
+
- After implementing a feature
|
|
11
|
+
- After fixing a bug
|
|
12
|
+
- Before a release
|
|
13
|
+
- After refactoring code
|
|
14
|
+
|
|
15
|
+
## Steps
|
|
16
|
+
|
|
17
|
+
### 1. Identify Change Scope
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
1. Review the changes in the PR/commit
|
|
21
|
+
2. Identify affected modules
|
|
22
|
+
3. Map dependencies to other modules
|
|
23
|
+
4. Identify integration points
|
|
24
|
+
5. Note any API changes
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### 2. Check Core Functionality
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
1. Application startup/shutdown
|
|
31
|
+
2. Core user flows
|
|
32
|
+
3. Authentication/authorization
|
|
33
|
+
4. Data persistence
|
|
34
|
+
5. Critical business logic
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### 3. Check Affected Areas
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
1. Unit tests for changed modules
|
|
41
|
+
2. Integration tests for affected paths
|
|
42
|
+
3. E2E tests for user flows
|
|
43
|
+
4. Performance benchmarks
|
|
44
|
+
5. Security validations
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### 4. Check Neighboring Modules
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
1. Modules that depend on changed code
|
|
51
|
+
2. Modules that provide dependencies
|
|
52
|
+
3. Shared utilities and helpers
|
|
53
|
+
4. Configuration changes
|
|
54
|
+
5. Database migrations
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### 5. Check Edge Cases
|
|
58
|
+
|
|
59
|
+
```
|
|
60
|
+
1. Error handling paths
|
|
61
|
+
2. Boundary conditions
|
|
62
|
+
3. Null/empty inputs
|
|
63
|
+
4. Concurrent access scenarios
|
|
64
|
+
5. Resource exhaustion
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### 6. Verify Non-Functional
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+
1. Performance: No significant degradation
|
|
71
|
+
2. Security: No new vulnerabilities
|
|
72
|
+
3. Accessibility: WCAG compliance maintained
|
|
73
|
+
4. Compatibility: Browser/platform support
|
|
74
|
+
5. Logging: Appropriate log levels
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### 7. Run Test Suite
|
|
78
|
+
|
|
79
|
+
```
|
|
80
|
+
1. Run all unit tests
|
|
81
|
+
2. Run all integration tests
|
|
82
|
+
3. Run E2E tests
|
|
83
|
+
4. Check test coverage
|
|
84
|
+
5. Verify no flaky tests
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Regression Checklist Template
|
|
88
|
+
|
|
89
|
+
```markdown
|
|
90
|
+
## Regression Checklist: [PR/Task Title]
|
|
91
|
+
|
|
92
|
+
### Change Summary
|
|
93
|
+
[Brief description of changes]
|
|
94
|
+
|
|
95
|
+
### Affected Modules
|
|
96
|
+
- [ ] `module1` - [Description of change]
|
|
97
|
+
- [ ] `module2` - [Description of change]
|
|
98
|
+
|
|
99
|
+
### Core Functionality
|
|
100
|
+
- [ ] Application starts correctly
|
|
101
|
+
- [ ] Application shuts down gracefully
|
|
102
|
+
- [ ] Core user flows work
|
|
103
|
+
- [ ] Authentication works
|
|
104
|
+
- [ ] Authorization works
|
|
105
|
+
- [ ] Data can be saved
|
|
106
|
+
- [ ] Data can be retrieved
|
|
107
|
+
|
|
108
|
+
### Module-Specific Tests
|
|
109
|
+
- [ ] Unit tests pass for affected modules
|
|
110
|
+
- [ ] Integration tests pass for affected paths
|
|
111
|
+
- [ ] E2E tests pass for affected flows
|
|
112
|
+
|
|
113
|
+
### Dependency Checks
|
|
114
|
+
- [ ] Upstream modules work correctly
|
|
115
|
+
- [ ] Downstream modules work correctly
|
|
116
|
+
- [ ] Shared utilities function properly
|
|
117
|
+
- [ ] External integrations work
|
|
118
|
+
|
|
119
|
+
### Edge Cases
|
|
120
|
+
- [ ] Error handling works
|
|
121
|
+
- [ ] Boundary conditions handled
|
|
122
|
+
- [ ] Null/empty inputs handled
|
|
123
|
+
- [ ] Concurrent access safe
|
|
124
|
+
|
|
125
|
+
### Non-Functional
|
|
126
|
+
- [ ] Performance acceptable
|
|
127
|
+
- [ ] No security regressions
|
|
128
|
+
- [ ] Accessibility maintained
|
|
129
|
+
- [ ] Compatible with supported platforms
|
|
130
|
+
- [ ] Logs appropriate
|
|
131
|
+
|
|
132
|
+
### Test Results
|
|
133
|
+
- Unit Tests: PASS / FAIL
|
|
134
|
+
- Integration Tests: PASS / FAIL
|
|
135
|
+
- E2E Tests: PASS / FAIL
|
|
136
|
+
- Coverage: XX%
|
|
137
|
+
|
|
138
|
+
### Notes
|
|
139
|
+
[Any additional observations or concerns]
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
## Risk Assessment Matrix
|
|
143
|
+
|
|
144
|
+
| Change Type | Risk Level | Recommended Testing |
|
|
145
|
+
|-------------|------------|---------------------|
|
|
146
|
+
| Single file bug fix | Low | Unit tests + affected module tests |
|
|
147
|
+
| Multi-file bug fix | Medium | All tests + integration tests |
|
|
148
|
+
| New feature | Medium | All tests + E2E + manual |
|
|
149
|
+
| API change | High | All tests + E2E + contract tests |
|
|
150
|
+
| Database migration | High | All tests + migration tests |
|
|
151
|
+
| Refactoring | Medium | All tests + coverage check |
|
|
152
|
+
| Dependency update | Medium | All tests + compatibility check |
|
|
153
|
+
| Configuration change | Low-Medium | Integration tests + E2E |
|
|
154
|
+
|
|
155
|
+
## Checklist
|
|
156
|
+
|
|
157
|
+
- [ ] Change scope identified
|
|
158
|
+
- [ ] Core functionality verified
|
|
159
|
+
- [ ] Affected modules tested
|
|
160
|
+
- [ ] Neighboring modules checked
|
|
161
|
+
- [ ] Edge cases tested
|
|
162
|
+
- [ ] Non-functional requirements met
|
|
163
|
+
- [ ] Test suite passed
|
|
164
|
+
- [ ] Coverage acceptable
|
|
165
|
+
- [ ] Documentation updated
|
|
166
|
+
|
|
167
|
+
## Best Practices
|
|
168
|
+
|
|
169
|
+
- Test more than just the changed code
|
|
170
|
+
- Pay attention to error paths
|
|
171
|
+
- Check for race conditions in async code
|
|
172
|
+
- Verify logging and monitoring
|
|
173
|
+
- Test in realistic environments
|
|
174
|
+
- Include performance-critical paths
|
|
175
|
+
- Check backward compatibility
|
|
176
|
+
- Document any known issues
|
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
# Release Readiness Check
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
This skill ensures code is ready for production release through comprehensive pre-release validation.
|
|
6
|
+
|
|
7
|
+
## When to Use
|
|
8
|
+
|
|
9
|
+
- Before merging to main/release branch
|
|
10
|
+
- Before deploying to production
|
|
11
|
+
- Before creating a release
|
|
12
|
+
- During release candidate review
|
|
13
|
+
|
|
14
|
+
## Steps
|
|
15
|
+
|
|
16
|
+
### 1. Code Quality Verification
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
1. All tests pass (unit, integration, E2E)
|
|
20
|
+
2. Code coverage meets threshold (≥80%)
|
|
21
|
+
3. No linting errors
|
|
22
|
+
4. No type errors
|
|
23
|
+
5. No security vulnerabilities
|
|
24
|
+
6. Technical debt documented
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### 2. Documentation Review
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
1. README updated if needed
|
|
31
|
+
2. API documentation current
|
|
32
|
+
3. CHANGELOG/RELEASE_NOTES updated
|
|
33
|
+
4. Breaking changes documented
|
|
34
|
+
5. Migration guide provided (if needed)
|
|
35
|
+
6. Configuration changes documented
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### 3. Breaking Changes Assessment
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
1. Identify API changes
|
|
42
|
+
2. Check backward compatibility
|
|
43
|
+
3. Document deprecation notices
|
|
44
|
+
4. Plan migration path for users
|
|
45
|
+
5. Version bump appropriate
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### 4. Security Review
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
1. No hardcoded secrets
|
|
52
|
+
2. No SQL injection vulnerabilities
|
|
53
|
+
3. No XSS vulnerabilities
|
|
54
|
+
4. Authentication flows correct
|
|
55
|
+
5. Authorization checks in place
|
|
56
|
+
6. Sensitive data encrypted
|
|
57
|
+
7. Dependencies checked for vulnerabilities
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### 5. Performance Validation
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
1. No significant performance regressions
|
|
64
|
+
2. Memory usage acceptable
|
|
65
|
+
3. Startup time acceptable
|
|
66
|
+
4. Response times within SLA
|
|
67
|
+
5. Resource cleanup correct
|
|
68
|
+
6. No memory leaks
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### 6. Infrastructure Readiness
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
1. Database migrations ready
|
|
75
|
+
2. Feature flags configured
|
|
76
|
+
3. Rollback plan documented
|
|
77
|
+
4. Monitoring/alerting updated
|
|
78
|
+
5. Load testing completed (if applicable)
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### 7. Release Documentation
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
1. Version number determined
|
|
85
|
+
2. Release notes prepared
|
|
86
|
+
3. Known issues documented
|
|
87
|
+
4. Breaking changes listed
|
|
88
|
+
5. Upgrade instructions provided
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## Release Readiness Checklist Template
|
|
92
|
+
|
|
93
|
+
```markdown
|
|
94
|
+
## Release Readiness: [Version X.Y.Z]
|
|
95
|
+
|
|
96
|
+
### Code Quality
|
|
97
|
+
- [ ] All unit tests pass
|
|
98
|
+
- [ ] All integration tests pass
|
|
99
|
+
- [ ] All E2E tests pass
|
|
100
|
+
- [ ] Code coverage: XX% (threshold: 80%)
|
|
101
|
+
- [ ] No linting errors
|
|
102
|
+
- [ ] No type errors
|
|
103
|
+
- [ ] Static analysis clean
|
|
104
|
+
|
|
105
|
+
### Security
|
|
106
|
+
- [ ] No hardcoded secrets
|
|
107
|
+
- [ ] No known vulnerabilities in dependencies
|
|
108
|
+
- [ ] Security scan passed
|
|
109
|
+
- [ ] Authentication verified
|
|
110
|
+
- [ ] Authorization verified
|
|
111
|
+
- [ ] Input validation in place
|
|
112
|
+
- [ ] Output encoding correct
|
|
113
|
+
|
|
114
|
+
### Documentation
|
|
115
|
+
- [ ] README up to date
|
|
116
|
+
- [ ] API documentation current
|
|
117
|
+
- [ ] CHANGELOG updated
|
|
118
|
+
- [ ] Breaking changes documented
|
|
119
|
+
- [ ] Migration guide provided
|
|
120
|
+
- [ ] Configuration documented
|
|
121
|
+
|
|
122
|
+
### Performance
|
|
123
|
+
- [ ] No performance regressions
|
|
124
|
+
- [ ] Memory usage acceptable
|
|
125
|
+
- [ ] Startup time acceptable
|
|
126
|
+
- [ ] Response times within SLA
|
|
127
|
+
- [ ] Load tested (if applicable)
|
|
128
|
+
|
|
129
|
+
### Infrastructure
|
|
130
|
+
- [ ] Database migrations ready
|
|
131
|
+
- [ ] Feature flags configured
|
|
132
|
+
- [ ] Monitoring updated
|
|
133
|
+
- [ ] Rollback plan ready
|
|
134
|
+
- [ ] Deployment tested
|
|
135
|
+
|
|
136
|
+
### Versioning
|
|
137
|
+
- [ ] Version number appropriate
|
|
138
|
+
- [ ] Breaking changes → Major version
|
|
139
|
+
- [ ] New features → Minor version
|
|
140
|
+
- [ ] Bug fixes → Patch version
|
|
141
|
+
|
|
142
|
+
### Release Notes Draft
|
|
143
|
+
```
|
|
144
|
+
## [Version X.Y.Z] - YYYY-MM-DD
|
|
145
|
+
|
|
146
|
+
### Added
|
|
147
|
+
- [New features]
|
|
148
|
+
|
|
149
|
+
### Changed
|
|
150
|
+
- [Changes]
|
|
151
|
+
|
|
152
|
+
### Fixed
|
|
153
|
+
- [Bug fixes]
|
|
154
|
+
|
|
155
|
+
### Breaking Changes
|
|
156
|
+
- [Breaking changes with migration guide]
|
|
157
|
+
|
|
158
|
+
### Known Issues
|
|
159
|
+
- [Known issues]
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Approval
|
|
163
|
+
- [ ] Code review approved
|
|
164
|
+
- [ ] QA approved
|
|
165
|
+
- [ ] Security review (if applicable)
|
|
166
|
+
- [ ] Product owner approval (if applicable)
|
|
167
|
+
|
|
168
|
+
### Sign-off
|
|
169
|
+
- **Prepared by**: [Name]
|
|
170
|
+
- **Reviewed by**: [Name]
|
|
171
|
+
- **Approved by**: [Name]
|
|
172
|
+
- **Target Date**: [Date]
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
## Version Bumping Guide
|
|
176
|
+
|
|
177
|
+
| Change Type | Version Bump | Example |
|
|
178
|
+
|-------------|--------------|---------|
|
|
179
|
+
| Breaking API change | Major | 1.0.0 → 2.0.0 |
|
|
180
|
+
| New feature (backward compatible) | Minor | 1.0.0 → 1.1.0 |
|
|
181
|
+
| Bug fix (backward compatible) | Patch | 1.0.0 → 1.0.1 |
|
|
182
|
+
| Internal change | Patch | 1.0.0 → 1.0.1 |
|
|
183
|
+
|
|
184
|
+
## Release Gates
|
|
185
|
+
|
|
186
|
+
| Gate | Must Pass | Can Waive |
|
|
187
|
+
|------|-----------|-----------|
|
|
188
|
+
| All tests pass | Yes | No |
|
|
189
|
+
| No security vulnerabilities | Yes | No |
|
|
190
|
+
| Code coverage met | Yes | With approval |
|
|
191
|
+
| Documentation updated | Yes | With approval |
|
|
192
|
+
| Performance acceptable | Yes | With approval |
|
|
193
|
+
| Code review approved | Yes | No |
|
|
194
|
+
|
|
195
|
+
## Checklist
|
|
196
|
+
|
|
197
|
+
- [ ] Code quality verified
|
|
198
|
+
- [ ] Security reviewed
|
|
199
|
+
- [ ] Documentation complete
|
|
200
|
+
- [ ] Performance validated
|
|
201
|
+
- [ ] Infrastructure ready
|
|
202
|
+
- [ ] Release notes prepared
|
|
203
|
+
- [ ] Version bumped appropriately
|
|
204
|
+
- [ ] All gates passed
|
|
205
|
+
- [ ] Approvals obtained
|
|
206
|
+
|
|
207
|
+
## Best Practices
|
|
208
|
+
|
|
209
|
+
- Never skip security review
|
|
210
|
+
- Document all decisions
|
|
211
|
+
- Test rollback procedure
|
|
212
|
+
- Communicate breaking changes early
|
|
213
|
+
- Provide upgrade guides
|
|
214
|
+
- Keep release notes user-friendly
|
|
215
|
+
- Test in production-like environment
|
|
216
|
+
- Have a rollback plan ready
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
# Repository Architecture Reader
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
This skill enables an agent to quickly understand and document a repository's architecture, structure, and design patterns.
|
|
6
|
+
|
|
7
|
+
## When to Use
|
|
8
|
+
|
|
9
|
+
- Starting work on a new repository
|
|
10
|
+
- Analyzing codebase for the first time
|
|
11
|
+
- Creating architecture documentation
|
|
12
|
+
- Planning major refactoring
|
|
13
|
+
- Onboarding new team members
|
|
14
|
+
|
|
15
|
+
## Steps
|
|
16
|
+
|
|
17
|
+
### 1. Initial Exploration
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
1. Identify the project type (web app, library, CLI, etc.)
|
|
21
|
+
2. Locate configuration files (package.json, tsconfig.json, etc.)
|
|
22
|
+
3. Identify the main entry point(s)
|
|
23
|
+
4. Map the top-level directory structure
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
### 2. Dependency Analysis
|
|
27
|
+
|
|
28
|
+
```
|
|
29
|
+
1. Parse package.json / requirements.txt / Cargo.toml
|
|
30
|
+
2. Categorize dependencies:
|
|
31
|
+
- Production dependencies
|
|
32
|
+
- Development dependencies
|
|
33
|
+
- Peer dependencies
|
|
34
|
+
3. Identify the tech stack:
|
|
35
|
+
- Framework(s)
|
|
36
|
+
- Build tools
|
|
37
|
+
- Testing frameworks
|
|
38
|
+
- Linting/formatting tools
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### 3. Code Organization
|
|
42
|
+
|
|
43
|
+
```
|
|
44
|
+
1. Identify source code directories
|
|
45
|
+
2. Map module structure:
|
|
46
|
+
- Core modules
|
|
47
|
+
- Shared/utilities
|
|
48
|
+
- Domain-specific modules
|
|
49
|
+
- Third-party integrations
|
|
50
|
+
3. Identify architectural patterns:
|
|
51
|
+
- MVC/MVVM/MVI
|
|
52
|
+
- Layered architecture
|
|
53
|
+
- Microservices
|
|
54
|
+
- Monorepo structure
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### 4. Data Flow Analysis
|
|
58
|
+
|
|
59
|
+
```
|
|
60
|
+
1. Trace main data flows
|
|
61
|
+
2. Identify state management
|
|
62
|
+
3. Map API boundaries
|
|
63
|
+
4. Document event flows
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### 5. Configuration & Environment
|
|
67
|
+
|
|
68
|
+
```
|
|
69
|
+
1. Identify environment configuration
|
|
70
|
+
2. Map configuration sources
|
|
71
|
+
3. Document secrets management
|
|
72
|
+
4. Note feature flags
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### 6. Testing Structure
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
1. Locate test files
|
|
79
|
+
2. Identify test types:
|
|
80
|
+
- Unit tests
|
|
81
|
+
- Integration tests
|
|
82
|
+
- E2E tests
|
|
83
|
+
3. Document test utilities and fixtures
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## Output Format
|
|
87
|
+
|
|
88
|
+
```markdown
|
|
89
|
+
# Repository Architecture: [Project Name]
|
|
90
|
+
|
|
91
|
+
## Overview
|
|
92
|
+
[Brief description of the project]
|
|
93
|
+
|
|
94
|
+
## Tech Stack
|
|
95
|
+
- **Language**: [Primary language]
|
|
96
|
+
- **Framework**: [Main framework]
|
|
97
|
+
- **Build Tool**: [Build tool]
|
|
98
|
+
- **Testing**: [Testing framework]
|
|
99
|
+
|
|
100
|
+
## Directory Structure
|
|
101
|
+
```
|
|
102
|
+
project/
|
|
103
|
+
├── src/ # Source code
|
|
104
|
+
│ ├── core/ # Core business logic
|
|
105
|
+
│ ├── api/ # API layer
|
|
106
|
+
│ ├── utils/ # Utilities
|
|
107
|
+
│ └── index.ts # Entry point
|
|
108
|
+
├── tests/ # Test files
|
|
109
|
+
├── docs/ # Documentation
|
|
110
|
+
└── config/ # Configuration
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
## Key Modules
|
|
114
|
+
|
|
115
|
+
### [Module Name]
|
|
116
|
+
- **Purpose**: [What this module does]
|
|
117
|
+
- **Dependencies**: [What it depends on]
|
|
118
|
+
- **Consumers**: [What depends on it]
|
|
119
|
+
- **Key Files**: [Important files]
|
|
120
|
+
|
|
121
|
+
## Data Flow
|
|
122
|
+
[Description or diagram of data flow]
|
|
123
|
+
|
|
124
|
+
## Configuration
|
|
125
|
+
[How configuration is managed]
|
|
126
|
+
|
|
127
|
+
## Testing Strategy
|
|
128
|
+
[How testing is organized]
|
|
129
|
+
|
|
130
|
+
## Notes
|
|
131
|
+
[Any special considerations or gotchas]
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## Best Practices
|
|
135
|
+
|
|
136
|
+
- Start with high-level understanding before diving deep
|
|
137
|
+
- Use diagrams for complex relationships
|
|
138
|
+
- Note any anti-patterns or technical debt
|
|
139
|
+
- Keep documentation updated as codebase evolves
|