baldart 3.6.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.
- package/CHANGELOG.md +599 -0
- package/README.md +566 -0
- package/VERSION +1 -0
- package/bin/baldart.js +143 -0
- package/framework/.claude/agents/REGISTRY.md +169 -0
- package/framework/.claude/agents/api-perf-cost-auditor.md +291 -0
- package/framework/.claude/agents/code-reviewer.md +350 -0
- package/framework/.claude/agents/codebase-architect.md +391 -0
- package/framework/.claude/agents/coder.md +291 -0
- package/framework/.claude/agents/deep-human-insight.md +198 -0
- package/framework/.claude/agents/doc-reviewer.md +440 -0
- package/framework/.claude/agents/email-deliverability-architect.md +193 -0
- package/framework/.claude/agents/hybrid-ml-architect.md +285 -0
- package/framework/.claude/agents/hyper-gamification-designer.md +149 -0
- package/framework/.claude/agents/legal-counsel-gdpr.md +179 -0
- package/framework/.claude/agents/marketing-conversion-strategist.md +162 -0
- package/framework/.claude/agents/motion-expert.md +108 -0
- package/framework/.claude/agents/onboarding-architect-lead.md +230 -0
- package/framework/.claude/agents/plan-auditor.md +546 -0
- package/framework/.claude/agents/prd-card-writer.md +372 -0
- package/framework/.claude/agents/prd.md +744 -0
- package/framework/.claude/agents/qa-sentinel.md +305 -0
- package/framework/.claude/agents/remotion-animator-orchestrator.md +218 -0
- package/framework/.claude/agents/security-reviewer.md +276 -0
- package/framework/.claude/agents/senior-researcher.md +175 -0
- package/framework/.claude/agents/seo-analytics-strategist.md +156 -0
- package/framework/.claude/agents/skill-improver.md +61 -0
- package/framework/.claude/agents/ui-expert.md +191 -0
- package/framework/.claude/agents/visual-designer.md +190 -0
- package/framework/.claude/agents/website-orchestrator.md +118 -0
- package/framework/.claude/agents/wiki-curator.md +145 -0
- package/framework/.claude/commands/baldart-push.md +15 -0
- package/framework/.claude/commands/check.md +237 -0
- package/framework/.claude/commands/codexreview.md +203 -0
- package/framework/.claude/commands/design-review.md +11 -0
- package/framework/.claude/commands/issue-review.md +34 -0
- package/framework/.claude/commands/new.md +331 -0
- package/framework/.claude/commands/qa.md +257 -0
- package/framework/.claude/hooks/framework-edit-gate.js +208 -0
- package/framework/.claude/hooks/lint-before-commit.sh.template +66 -0
- package/framework/.claude/settings.local.json.example +32 -0
- package/framework/.claude/skills/api-design-principles/SKILL.md +567 -0
- package/framework/.claude/skills/api-design-principles/assets/api-design-checklist.md +155 -0
- package/framework/.claude/skills/api-design-principles/assets/rest-api-template.py +182 -0
- package/framework/.claude/skills/api-design-principles/references/graphql-schema-design.md +583 -0
- package/framework/.claude/skills/api-design-principles/references/rest-best-practices.md +408 -0
- package/framework/.claude/skills/baldart-push/SKILL.md +222 -0
- package/framework/.claude/skills/bug/SKILL.md +200 -0
- package/framework/.claude/skills/bug/references/logging-patterns.md +174 -0
- package/framework/.claude/skills/capture/SKILL.md +125 -0
- package/framework/.claude/skills/capture/references/synthesis-template.md +42 -0
- package/framework/.claude/skills/context-primer/SKILL.md +189 -0
- package/framework/.claude/skills/copywriting/SKILL.md +273 -0
- package/framework/.claude/skills/copywriting/references/copy-frameworks.md +338 -0
- package/framework/.claude/skills/copywriting/references/natural-transitions.md +252 -0
- package/framework/.claude/skills/doc-writing-for-rag/SKILL.md +119 -0
- package/framework/.claude/skills/doc-writing-for-rag/references/before-after-examples.md +291 -0
- package/framework/.claude/skills/doc-writing-for-rag/references/compact-templates.md +183 -0
- package/framework/.claude/skills/doc-writing-for-rag/references/frontmatter-minimal.md +112 -0
- package/framework/.claude/skills/doc-writing-for-rag/references/line-count-targets.md +110 -0
- package/framework/.claude/skills/doc-writing-for-rag/references/schemas-and-errors.md +129 -0
- package/framework/.claude/skills/find-skills/SKILL.md +133 -0
- package/framework/.claude/skills/frontend-design/LICENSE.txt +177 -0
- package/framework/.claude/skills/frontend-design/SKILL.md +84 -0
- package/framework/.claude/skills/gamification-design/SKILL.md +130 -0
- package/framework/.claude/skills/issue-review/SKILL.md +45 -0
- package/framework/.claude/skills/kie-ai/SKILL.md +262 -0
- package/framework/.claude/skills/kie-ai/references/models-catalog.md +272 -0
- package/framework/.claude/skills/kie-ai/scripts/kie_api.sh +209 -0
- package/framework/.claude/skills/kie-ai/scripts/remove_greenscreen.py +69 -0
- package/framework/.claude/skills/kie-ai/scripts/setup_api_key.sh +77 -0
- package/framework/.claude/skills/motion-design/LICENSE +21 -0
- package/framework/.claude/skills/motion-design/README.md +82 -0
- package/framework/.claude/skills/motion-design/SKILL.md +336 -0
- package/framework/.claude/skills/motion-design/director/choreography.md +93 -0
- package/framework/.claude/skills/motion-design/director/context-adaptation.md +83 -0
- package/framework/.claude/skills/motion-design/director/core-philosophy.md +53 -0
- package/framework/.claude/skills/motion-design/director/decision-framework.md +91 -0
- package/framework/.claude/skills/motion-design/director/disney-principles.md +102 -0
- package/framework/.claude/skills/motion-design/director/emotion-mapping.md +71 -0
- package/framework/.claude/skills/motion-design/director/motion-personality.md +89 -0
- package/framework/.claude/skills/motion-design/director/narrative-structure.md +62 -0
- package/framework/.claude/skills/motion-design/patterns/ambient-continuous.md +81 -0
- package/framework/.claude/skills/motion-design/patterns/entrance-exit.md +82 -0
- package/framework/.claude/skills/motion-design/patterns/multi-element.md +69 -0
- package/framework/.claude/skills/motion-design/patterns/state-feedback.md +96 -0
- package/framework/.claude/skills/motion-design/reference/property-selection.md +95 -0
- package/framework/.claude/skills/motion-design/reference/quality-checklist.md +67 -0
- package/framework/.claude/skills/motion-design/reference/timing-easing-tables.md +106 -0
- package/framework/.claude/skills/motion-design/reference/troubleshooting.md +73 -0
- package/framework/.claude/skills/new/SKILL.md +1687 -0
- package/framework/.claude/skills/playwright-skill/API_REFERENCE.md +652 -0
- package/framework/.claude/skills/playwright-skill/SKILL.md +157 -0
- package/framework/.claude/skills/playwright-skill/package.json +26 -0
- package/framework/.claude/skills/prd/SKILL.md +228 -0
- package/framework/.claude/skills/prd/assets/card-template.yml +232 -0
- package/framework/.claude/skills/prd/assets/epic-template.yml +190 -0
- package/framework/.claude/skills/prd/assets/prd-template.md +230 -0
- package/framework/.claude/skills/prd/assets/state-template.md +78 -0
- package/framework/.claude/skills/prd/references/api-perf-gate.md +152 -0
- package/framework/.claude/skills/prd/references/audit-phase.md +478 -0
- package/framework/.claude/skills/prd/references/backlog-phase.md +145 -0
- package/framework/.claude/skills/prd/references/discovery-phase.md +359 -0
- package/framework/.claude/skills/prd/references/impact-analysis.md +233 -0
- package/framework/.claude/skills/prd/references/prd-add-phase.md +214 -0
- package/framework/.claude/skills/prd/references/prd-writing-phase.md +145 -0
- package/framework/.claude/skills/prd/references/research-phase.md +216 -0
- package/framework/.claude/skills/prd/references/ui-design-phase.md +61 -0
- package/framework/.claude/skills/prd/references/validation-phase.md +72 -0
- package/framework/.claude/skills/prd-add/SKILL.md +222 -0
- package/framework/.claude/skills/prd-add/references/impact-analysis.md +233 -0
- package/framework/.claude/skills/remotion-best-practices/SKILL.md +48 -0
- package/framework/.claude/skills/remotion-best-practices/rules/3d.md +86 -0
- package/framework/.claude/skills/remotion-best-practices/rules/animations.md +29 -0
- package/framework/.claude/skills/remotion-best-practices/rules/assets/charts-bar-chart.tsx +173 -0
- package/framework/.claude/skills/remotion-best-practices/rules/assets/text-animations-typewriter.tsx +100 -0
- package/framework/.claude/skills/remotion-best-practices/rules/assets/text-animations-word-highlight.tsx +108 -0
- package/framework/.claude/skills/remotion-best-practices/rules/assets.md +78 -0
- package/framework/.claude/skills/remotion-best-practices/rules/audio.md +169 -0
- package/framework/.claude/skills/remotion-best-practices/rules/calculate-metadata.md +104 -0
- package/framework/.claude/skills/remotion-best-practices/rules/can-decode.md +75 -0
- package/framework/.claude/skills/remotion-best-practices/rules/charts.md +58 -0
- package/framework/.claude/skills/remotion-best-practices/rules/compositions.md +141 -0
- package/framework/.claude/skills/remotion-best-practices/rules/display-captions.md +184 -0
- package/framework/.claude/skills/remotion-best-practices/rules/extract-frames.md +229 -0
- package/framework/.claude/skills/remotion-best-practices/rules/fonts.md +152 -0
- package/framework/.claude/skills/remotion-best-practices/rules/get-audio-duration.md +58 -0
- package/framework/.claude/skills/remotion-best-practices/rules/get-video-dimensions.md +68 -0
- package/framework/.claude/skills/remotion-best-practices/rules/get-video-duration.md +58 -0
- package/framework/.claude/skills/remotion-best-practices/rules/gifs.md +141 -0
- package/framework/.claude/skills/remotion-best-practices/rules/images.md +130 -0
- package/framework/.claude/skills/remotion-best-practices/rules/import-srt-captions.md +69 -0
- package/framework/.claude/skills/remotion-best-practices/rules/light-leaks.md +73 -0
- package/framework/.claude/skills/remotion-best-practices/rules/lottie.md +67 -0
- package/framework/.claude/skills/remotion-best-practices/rules/maps.md +401 -0
- package/framework/.claude/skills/remotion-best-practices/rules/measuring-dom-nodes.md +34 -0
- package/framework/.claude/skills/remotion-best-practices/rules/measuring-text.md +143 -0
- package/framework/.claude/skills/remotion-best-practices/rules/parameters.md +98 -0
- package/framework/.claude/skills/remotion-best-practices/rules/sequencing.md +118 -0
- package/framework/.claude/skills/remotion-best-practices/rules/subtitles.md +36 -0
- package/framework/.claude/skills/remotion-best-practices/rules/tailwind.md +11 -0
- package/framework/.claude/skills/remotion-best-practices/rules/text-animations.md +20 -0
- package/framework/.claude/skills/remotion-best-practices/rules/timing.md +179 -0
- package/framework/.claude/skills/remotion-best-practices/rules/transcribe-captions.md +70 -0
- package/framework/.claude/skills/remotion-best-practices/rules/transitions.md +197 -0
- package/framework/.claude/skills/remotion-best-practices/rules/transparent-videos.md +106 -0
- package/framework/.claude/skills/remotion-best-practices/rules/trimming.md +52 -0
- package/framework/.claude/skills/remotion-best-practices/rules/videos.md +171 -0
- package/framework/.claude/skills/seo-audit/SKILL.md +394 -0
- package/framework/.claude/skills/seo-audit/references/aeo-geo-patterns.md +279 -0
- package/framework/.claude/skills/seo-audit/references/ai-writing-detection.md +190 -0
- package/framework/.claude/skills/simplify/SKILL.md +137 -0
- package/framework/.claude/skills/skill-creator/LICENSE.txt +202 -0
- package/framework/.claude/skills/skill-creator/SKILL.md +356 -0
- package/framework/.claude/skills/skill-creator/references/output-patterns.md +82 -0
- package/framework/.claude/skills/skill-creator/references/workflows.md +28 -0
- package/framework/.claude/skills/skill-creator/scripts/init_skill.py +303 -0
- package/framework/.claude/skills/skill-creator/scripts/package_skill.py +110 -0
- package/framework/.claude/skills/skill-creator/scripts/quick_validate.py +95 -0
- package/framework/.claude/skills/ui-design/SKILL.md +199 -0
- package/framework/.claude/skills/ui-design/references/component-discovery.md +54 -0
- package/framework/.claude/skills/ui-design/references/evaluation.md +171 -0
- package/framework/.claude/skills/ui-design/references/generation.md +109 -0
- package/framework/.claude/skills/ui-design/references/inventory.md +59 -0
- package/framework/.claude/skills/webapp-testing/LICENSE.txt +202 -0
- package/framework/.claude/skills/webapp-testing/SKILL.md +123 -0
- package/framework/.claude/skills/webapp-testing/examples/console_logging.py +35 -0
- package/framework/.claude/skills/webapp-testing/examples/element_discovery.py +40 -0
- package/framework/.claude/skills/webapp-testing/examples/static_html_automation.py +33 -0
- package/framework/.claude/skills/webapp-testing/scripts/with_server.py +106 -0
- package/framework/.claude/skills/worktree-manager/SKILL.md +680 -0
- package/framework/AGENTS.md +240 -0
- package/framework/agents/api-contracts.md +137 -0
- package/framework/agents/architecture.md +145 -0
- package/framework/agents/coding-standards.md +148 -0
- package/framework/agents/data-model.md +110 -0
- package/framework/agents/deployment-protocol.md +232 -0
- package/framework/agents/design-review.md +172 -0
- package/framework/agents/env-reference.md +171 -0
- package/framework/agents/github-issue-subagent.md +252 -0
- package/framework/agents/index.md +261 -0
- package/framework/agents/llm-wiki-methodology.md +216 -0
- package/framework/agents/maintenance-protocol.md +305 -0
- package/framework/agents/observability.md +162 -0
- package/framework/agents/performance.md +155 -0
- package/framework/agents/project-context.md +145 -0
- package/framework/agents/runbook.md +208 -0
- package/framework/agents/security.md +168 -0
- package/framework/agents/skills-mapping.md +286 -0
- package/framework/agents/testing.md +111 -0
- package/framework/agents/workflows.md +215 -0
- package/framework/docs/PROJECT-CONFIGURATION.md +336 -0
- package/framework/docs/references/brand-guidelines.md +170 -0
- package/framework/docs/references/ui-guidelines.template.md +182 -0
- package/framework/routines/code-review.routine.yml +46 -0
- package/framework/routines/doc-review.routine.yml +45 -0
- package/framework/routines/ds-drift.routine.yml +52 -0
- package/framework/routines/full-sweep.routine.yml +51 -0
- package/framework/routines/index.yml +70 -0
- package/framework/routines/skill-improve.routine.yml +50 -0
- package/framework/routines/wiki-review.routine.yml +45 -0
- package/framework/templates/baldart.config.template.yml +113 -0
- package/framework/templates/breaking-change-checklist.md +484 -0
- package/framework/templates/feature-card.template.yml +125 -0
- package/framework/templates/overlays/README.md +44 -0
- package/framework/templates/overlays/copywriting.fidelity-example.md +62 -0
- package/framework/templates/overlays/ui-design.fidelity-example.md +75 -0
- package/framework/templates/skill-project-context.snippet.md +19 -0
- package/framework/templates/spec.template.md +208 -0
- package/package.json +51 -0
- package/src/commands/add.js +229 -0
- package/src/commands/configure.js +385 -0
- package/src/commands/doctor.js +486 -0
- package/src/commands/migrate.js +185 -0
- package/src/commands/push.js +0 -0
- package/src/commands/routines.js +269 -0
- package/src/commands/status.js +130 -0
- package/src/commands/update.js +419 -0
- package/src/commands/version.js +88 -0
- package/src/utils/contamination.js +400 -0
- package/src/utils/git.js +181 -0
- package/src/utils/hooks.js +152 -0
- package/src/utils/routine-adapters/claude-code-cloud.js +78 -0
- package/src/utils/routine-adapters/cron.js +138 -0
- package/src/utils/routine-adapters/github-actions.js +141 -0
- package/src/utils/routine-adapters/index.js +21 -0
- package/src/utils/routines.js +166 -0
- package/src/utils/state.js +143 -0
- package/src/utils/symlinks.js +425 -0
- package/src/utils/ui.js +133 -0
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
# GitHub Issue Workflow
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Define how to create, update, and manage GitHub issues.
|
|
6
|
+
|
|
7
|
+
## Scope
|
|
8
|
+
|
|
9
|
+
**In**: Issue creation, labeling, status tracking, resolution workflow.
|
|
10
|
+
**Out**: Project management (see agents/workflows.md).
|
|
11
|
+
|
|
12
|
+
## Do
|
|
13
|
+
|
|
14
|
+
- Create issues for bugs, features, and tasks
|
|
15
|
+
- Use clear, descriptive titles
|
|
16
|
+
- Add appropriate labels
|
|
17
|
+
- Link to related PRs/issues
|
|
18
|
+
- Update status regularly
|
|
19
|
+
|
|
20
|
+
## Do Not
|
|
21
|
+
|
|
22
|
+
- Close issues prematurely
|
|
23
|
+
- Skip reproduction steps for bugs
|
|
24
|
+
- Use vague titles
|
|
25
|
+
|
|
26
|
+
## Issue Types
|
|
27
|
+
|
|
28
|
+
### Bug Report
|
|
29
|
+
|
|
30
|
+
**Title format**: `[BUG] Brief description of the issue`
|
|
31
|
+
|
|
32
|
+
**Template**:
|
|
33
|
+
|
|
34
|
+
```markdown
|
|
35
|
+
## Description
|
|
36
|
+
[Clear description of the bug]
|
|
37
|
+
|
|
38
|
+
## Steps to Reproduce
|
|
39
|
+
1. [Step 1]
|
|
40
|
+
2. [Step 2]
|
|
41
|
+
3. [Step 3]
|
|
42
|
+
|
|
43
|
+
## Expected Behavior
|
|
44
|
+
[What should happen]
|
|
45
|
+
|
|
46
|
+
## Actual Behavior
|
|
47
|
+
[What actually happens]
|
|
48
|
+
|
|
49
|
+
## Environment
|
|
50
|
+
- OS: [e.g., macOS 13.0]
|
|
51
|
+
- Browser: [e.g., Chrome 120]
|
|
52
|
+
- Version: [e.g., 1.2.3]
|
|
53
|
+
|
|
54
|
+
## Screenshots/Logs
|
|
55
|
+
[If applicable]
|
|
56
|
+
|
|
57
|
+
## Additional Context
|
|
58
|
+
[Any other relevant information]
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Feature Request
|
|
62
|
+
|
|
63
|
+
**Title format**: `[FEATURE] Brief description of the feature`
|
|
64
|
+
|
|
65
|
+
**Template**:
|
|
66
|
+
|
|
67
|
+
```markdown
|
|
68
|
+
## Problem Statement
|
|
69
|
+
[What problem does this solve?]
|
|
70
|
+
|
|
71
|
+
## Proposed Solution
|
|
72
|
+
[How should it work?]
|
|
73
|
+
|
|
74
|
+
## Alternatives Considered
|
|
75
|
+
[Other approaches considered]
|
|
76
|
+
|
|
77
|
+
## Additional Context
|
|
78
|
+
[Any other relevant information]
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Task
|
|
82
|
+
|
|
83
|
+
**Title format**: `[TASK] Brief description of the task`
|
|
84
|
+
|
|
85
|
+
**Template**:
|
|
86
|
+
|
|
87
|
+
```markdown
|
|
88
|
+
## Description
|
|
89
|
+
[What needs to be done?]
|
|
90
|
+
|
|
91
|
+
## Acceptance Criteria
|
|
92
|
+
- [ ] [Criterion 1]
|
|
93
|
+
- [ ] [Criterion 2]
|
|
94
|
+
- [ ] [Criterion 3]
|
|
95
|
+
|
|
96
|
+
## Related Issues/PRs
|
|
97
|
+
[Links to related items]
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Labels
|
|
101
|
+
|
|
102
|
+
### Type Labels
|
|
103
|
+
|
|
104
|
+
- `bug`: Something isn't working
|
|
105
|
+
- `feature`: New feature request
|
|
106
|
+
- `enhancement`: Improvement to existing feature
|
|
107
|
+
- `documentation`: Documentation updates
|
|
108
|
+
- `refactor`: Code refactoring
|
|
109
|
+
- `test`: Test-related changes
|
|
110
|
+
|
|
111
|
+
### Priority Labels
|
|
112
|
+
|
|
113
|
+
- `priority: critical`: Requires immediate attention
|
|
114
|
+
- `priority: high`: Important, address soon
|
|
115
|
+
- `priority: medium`: Normal priority
|
|
116
|
+
- `priority: low`: Nice to have
|
|
117
|
+
|
|
118
|
+
### Status Labels
|
|
119
|
+
|
|
120
|
+
- `status: todo`: Not started
|
|
121
|
+
- `status: in-progress`: Being worked on
|
|
122
|
+
- `status: blocked`: Blocked by another issue
|
|
123
|
+
- `status: review`: Ready for review
|
|
124
|
+
- `status: done`: Completed
|
|
125
|
+
|
|
126
|
+
### Area Labels
|
|
127
|
+
|
|
128
|
+
- `area: frontend`: Frontend code
|
|
129
|
+
- `area: backend`: Backend code
|
|
130
|
+
- `area: api`: API changes
|
|
131
|
+
- `area: database`: Database changes
|
|
132
|
+
- `area: devops`: DevOps/infrastructure
|
|
133
|
+
|
|
134
|
+
### Special Labels
|
|
135
|
+
|
|
136
|
+
- `good first issue`: Good for newcomers
|
|
137
|
+
- `help wanted`: Looking for contributors
|
|
138
|
+
- `vibe review`: Fixed, needs user verification
|
|
139
|
+
- `qa`: QA/testing issue
|
|
140
|
+
- `wontfix`: Will not be fixed
|
|
141
|
+
- `duplicate`: Duplicate of another issue
|
|
142
|
+
|
|
143
|
+
## Issue Workflow
|
|
144
|
+
|
|
145
|
+
### 1. Creation
|
|
146
|
+
|
|
147
|
+
- Use appropriate template
|
|
148
|
+
- Fill in all sections
|
|
149
|
+
- Add relevant labels
|
|
150
|
+
- Assign if known
|
|
151
|
+
|
|
152
|
+
### 2. Triage
|
|
153
|
+
|
|
154
|
+
- Review new issues
|
|
155
|
+
- Add/update labels
|
|
156
|
+
- Set priority
|
|
157
|
+
- Assign to milestone if applicable
|
|
158
|
+
|
|
159
|
+
### 3. Development
|
|
160
|
+
|
|
161
|
+
- Link issue in commit: `Fixes #123`
|
|
162
|
+
- Link issue in PR description
|
|
163
|
+
- Update issue with progress
|
|
164
|
+
- Add `status: in-progress` label
|
|
165
|
+
|
|
166
|
+
### 4. Review
|
|
167
|
+
|
|
168
|
+
- Reference issue in PR
|
|
169
|
+
- Wait for CI/CD checks
|
|
170
|
+
- Get approval
|
|
171
|
+
- Merge PR
|
|
172
|
+
|
|
173
|
+
### 5. Verification
|
|
174
|
+
|
|
175
|
+
- Add `vibe review` label
|
|
176
|
+
- Leave issue open
|
|
177
|
+
- User/QA verifies fix
|
|
178
|
+
- Add verification comment
|
|
179
|
+
- Only close after verification
|
|
180
|
+
|
|
181
|
+
## Issue Resolution
|
|
182
|
+
|
|
183
|
+
### For Bug Fixes
|
|
184
|
+
|
|
185
|
+
1. Implement fix
|
|
186
|
+
2. Add tests
|
|
187
|
+
3. Create PR referencing issue
|
|
188
|
+
4. Merge PR
|
|
189
|
+
5. Add `vibe review` label
|
|
190
|
+
6. Leave issue open
|
|
191
|
+
7. Verify in production
|
|
192
|
+
8. Add verification comment
|
|
193
|
+
9. Leave open for tracking
|
|
194
|
+
|
|
195
|
+
### For Features
|
|
196
|
+
|
|
197
|
+
1. Implement feature
|
|
198
|
+
2. Add tests and docs
|
|
199
|
+
3. Create PR referencing issue
|
|
200
|
+
4. Merge PR
|
|
201
|
+
5. Deploy to production
|
|
202
|
+
6. Update issue with deployment info
|
|
203
|
+
7. Can close after successful deployment
|
|
204
|
+
|
|
205
|
+
## Linking Issues and PRs
|
|
206
|
+
|
|
207
|
+
### In Commit Messages
|
|
208
|
+
|
|
209
|
+
```bash
|
|
210
|
+
git commit -m "Fix login bug
|
|
211
|
+
|
|
212
|
+
Fixes #123
|
|
213
|
+
Closes #456"
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
### In PR Descriptions
|
|
217
|
+
|
|
218
|
+
```markdown
|
|
219
|
+
## Description
|
|
220
|
+
[PR description]
|
|
221
|
+
|
|
222
|
+
## Related Issues
|
|
223
|
+
Fixes #123
|
|
224
|
+
Relates to #456
|
|
225
|
+
Blocks #789
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
## Issue Search
|
|
229
|
+
|
|
230
|
+
Use GitHub search to find issues:
|
|
231
|
+
|
|
232
|
+
- `is:open is:issue label:bug` - Open bugs
|
|
233
|
+
- `is:closed is:issue label:feature` - Closed features
|
|
234
|
+
- `is:issue author:@me` - Your issues
|
|
235
|
+
- `is:issue assignee:@me` - Assigned to you
|
|
236
|
+
|
|
237
|
+
## Issue Templates
|
|
238
|
+
|
|
239
|
+
Create `.github/ISSUE_TEMPLATE/` directory with:
|
|
240
|
+
|
|
241
|
+
- `bug_report.md`
|
|
242
|
+
- `feature_request.md`
|
|
243
|
+
- `task.md`
|
|
244
|
+
|
|
245
|
+
## Automation
|
|
246
|
+
|
|
247
|
+
Consider GitHub Actions for:
|
|
248
|
+
|
|
249
|
+
- Auto-labeling based on title
|
|
250
|
+
- Stale issue management
|
|
251
|
+
- PR/issue linking validation
|
|
252
|
+
- Automatic milestone assignment
|
|
@@ -0,0 +1,261 @@
|
|
|
1
|
+
<!-- contamination-scan: skip
|
|
2
|
+
This routing manifest uses literal example module names ("users.md",
|
|
3
|
+
"customer.md", etc.) in illustrative API/UI documentation flows. They
|
|
4
|
+
are pedagogical examples, not project-leak. -->
|
|
5
|
+
# Agents Index
|
|
6
|
+
|
|
7
|
+
## Purpose
|
|
8
|
+
|
|
9
|
+
Route agents to the right module with minimal reading.
|
|
10
|
+
|
|
11
|
+
## Routing Rules
|
|
12
|
+
|
|
13
|
+
### Documentation Routing
|
|
14
|
+
|
|
15
|
+
- **MANDATORY pre-read for any skill/agent that touches project-specific paths, identity, stack, or feature toggles** -> read `agents/project-context.md`. Skills consult `baldart.config.yml` + `.baldart/overlays/<skill>.md` instead of hard-coded paths; missing keys MUST be asked, never assumed.
|
|
16
|
+
- If needing to understand codebase structure, existing patterns, or architecture before planning -> MUST invoke `codebase-architect` agent (via Task tool) first; do not proceed without architectural understanding.
|
|
17
|
+
- If touching API endpoints or request/response shape -> read `agents/api-contracts.md` and `${paths.references_dir}/api/index.md` (then specific API module for your domain).
|
|
18
|
+
- If touching database schema or fields -> read `agents/data-model.md` and `${paths.references_dir}/data-model.md`.
|
|
19
|
+
- If touching UI pages/routes or flows -> read `${paths.references_dir}/ui/index.md` (then specific UI module for your domain).
|
|
20
|
+
- If touching design-review workflows or UI guidelines -> read `agents/design-review.md` and project-specific UI guidelines.
|
|
21
|
+
- If touching architecture, auth, or tech stack -> read `agents/architecture.md`.
|
|
22
|
+
- If touching workflow/process/commits/backlog -> read `agents/workflows.md`.
|
|
23
|
+
- If touching testing or QA issues -> read `agents/testing.md`.
|
|
24
|
+
- If touching GitHub issues or issue workflow -> read `agents/github-issue-subagent.md`.
|
|
25
|
+
- If touching terminology or naming -> read `agents/coding-standards.md`.
|
|
26
|
+
- If touching env vars or scripts -> read `agents/runbook.md` and `agents/env-reference.md`.
|
|
27
|
+
- If touching operational procedures (backup, cleanup, secrets) -> read `docs/operations/` if it exists in your project.
|
|
28
|
+
- If touching security or auth risk -> read `agents/security.md`.
|
|
29
|
+
- If touching performance limits or scaling -> read `agents/performance.md`.
|
|
30
|
+
- If touching monitoring/logging -> read `agents/observability.md`.
|
|
31
|
+
- If building or maintaining a derived LLM wiki overlay (`${paths.wiki_dir}/`) -> read `agents/llm-wiki-methodology.md` and invoke `wiki-curator` / `/capture`.
|
|
32
|
+
- For day-to-day status -> read and update `${paths.references_dir}/project-status.md`.
|
|
33
|
+
- For legacy context -> read `archive/project_full_legacy.md` if it exists.
|
|
34
|
+
|
|
35
|
+
### Agent Invocation Routing (via Task tool)
|
|
36
|
+
|
|
37
|
+
**Single source of truth**: See [`.claude/agents/REGISTRY.md`](../.claude/agents/REGISTRY.md) for the full agent map, decision tree, capabilities, and tool access.
|
|
38
|
+
|
|
39
|
+
When adding or updating agents, update REGISTRY.md — not this file.
|
|
40
|
+
|
|
41
|
+
## Modules
|
|
42
|
+
|
|
43
|
+
- `agents/architecture.md`
|
|
44
|
+
- `agents/coding-standards.md`
|
|
45
|
+
- `agents/workflows.md`
|
|
46
|
+
- `agents/testing.md`
|
|
47
|
+
- `agents/security.md`
|
|
48
|
+
- `agents/performance.md`
|
|
49
|
+
- `agents/observability.md`
|
|
50
|
+
- `agents/api-contracts.md`
|
|
51
|
+
- `agents/data-model.md`
|
|
52
|
+
- `agents/runbook.md`
|
|
53
|
+
- `agents/env-reference.md`
|
|
54
|
+
- `agents/maintenance-protocol.md`
|
|
55
|
+
- `agents/github-issue-subagent.md`
|
|
56
|
+
- `agents/design-review.md`
|
|
57
|
+
- `agents/skills-mapping.md`
|
|
58
|
+
- `agents/llm-wiki-methodology.md` — LLM wiki overlay methodology + auto-learning loop (since v2.0.0)
|
|
59
|
+
- `agents/project-context.md` — Project context protocol: `baldart.config.yml` + overlays + missing-key handling (since v3.0.0)
|
|
60
|
+
|
|
61
|
+
## Where to Document (Decision Tree)
|
|
62
|
+
|
|
63
|
+
Use these flowcharts to determine where documentation changes belong.
|
|
64
|
+
|
|
65
|
+
### Code Change Documentation
|
|
66
|
+
|
|
67
|
+
When you make a code change, follow this decision tree:
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+
START: You made a code change
|
|
71
|
+
|
|
|
72
|
+
v
|
|
73
|
+
Is it an API endpoint change?
|
|
74
|
+
|-- YES --> Update ${paths.references_dir}/api/{module}.md
|
|
75
|
+
| (Organize API docs by domain/feature)
|
|
76
|
+
|
|
|
77
|
+
v
|
|
78
|
+
Is it a database schema change?
|
|
79
|
+
|-- YES --> Update ${paths.references_dir}/data-model.md
|
|
80
|
+
| + Create ADR if structural
|
|
81
|
+
|
|
|
82
|
+
v
|
|
83
|
+
Is it a UI page/route change?
|
|
84
|
+
|-- YES --> Update ${paths.references_dir}/ui/{domain}.md (see ui/index.md)
|
|
85
|
+
|
|
|
86
|
+
v
|
|
87
|
+
Is it an architectural decision?
|
|
88
|
+
|-- YES --> Create ADR in ${paths.adrs_dir}/
|
|
89
|
+
| + Update agents/architecture.md if persistent
|
|
90
|
+
|
|
|
91
|
+
v
|
|
92
|
+
Is it a security-related change?
|
|
93
|
+
|-- YES --> Update agents/security.md
|
|
94
|
+
| + Create ADR if policy change
|
|
95
|
+
|
|
|
96
|
+
v
|
|
97
|
+
Is it a workflow/process change?
|
|
98
|
+
|-- YES --> Update agents/workflows.md
|
|
99
|
+
|
|
|
100
|
+
v
|
|
101
|
+
Does it affect project status?
|
|
102
|
+
|-- YES --> Update ${paths.references_dir}/project-status.md
|
|
103
|
+
|
|
|
104
|
+
v
|
|
105
|
+
DONE: Commit with docs updated
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### API Module Routing
|
|
109
|
+
|
|
110
|
+
When documenting an API endpoint, select the correct module based on your project's domain structure:
|
|
111
|
+
|
|
112
|
+
```
|
|
113
|
+
START: New or modified API endpoint
|
|
114
|
+
|
|
|
115
|
+
v
|
|
116
|
+
Identify the domain/feature area
|
|
117
|
+
|
|
|
118
|
+
v
|
|
119
|
+
Does a module exist for this domain?
|
|
120
|
+
|-- YES --> Update that module (e.g., auth.md, users.md, products.md)
|
|
121
|
+
|-- NO --> Create new module or add to closest existing module
|
|
122
|
+
|
|
|
123
|
+
v
|
|
124
|
+
Update ${paths.references_dir}/api/index.md with module reference
|
|
125
|
+
|
|
|
126
|
+
v
|
|
127
|
+
DONE: Document endpoint following project standards
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Documentation-Only Changes
|
|
131
|
+
|
|
132
|
+
When you need to update documentation without code changes:
|
|
133
|
+
|
|
134
|
+
```
|
|
135
|
+
START: Documentation update needed
|
|
136
|
+
|
|
|
137
|
+
v
|
|
138
|
+
Is it fixing a typo/broken link?
|
|
139
|
+
|-- YES --> Fix directly, no ADR needed
|
|
140
|
+
|
|
|
141
|
+
v
|
|
142
|
+
Is it clarifying existing behavior?
|
|
143
|
+
|-- YES --> Update the relevant reference doc
|
|
144
|
+
| (data-model, ui/{domain}, api/*)
|
|
145
|
+
|
|
|
146
|
+
v
|
|
147
|
+
Is it adding new guidance/rules?
|
|
148
|
+
|-- YES --> Is it agent-specific?
|
|
149
|
+
| |-- YES --> Update agents/{topic}.md
|
|
150
|
+
| |-- NO --> Update ${paths.references_dir}/{topic}.md
|
|
151
|
+
|
|
|
152
|
+
v
|
|
153
|
+
Is it documenting a decision?
|
|
154
|
+
|-- YES --> Create ADR in ${paths.adrs_dir}/
|
|
155
|
+
|
|
|
156
|
+
v
|
|
157
|
+
Is it changing this file (index.md)?
|
|
158
|
+
|-- YES --> Update this file + AGENTS.md routing section
|
|
159
|
+
|
|
|
160
|
+
v
|
|
161
|
+
DONE: Commit with clear message
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
## Quick Reference Table
|
|
167
|
+
|
|
168
|
+
| What Changed | Where to Document | Also Update |
|
|
169
|
+
|--------------|-------------------|-------------|
|
|
170
|
+
| API endpoint | `${paths.references_dir}/api/{domain}.md` | `api/index.md` if new endpoint |
|
|
171
|
+
| Database schema | `${paths.references_dir}/data-model.md` | API module if affects endpoints |
|
|
172
|
+
| UI page/route | `${paths.references_dir}/ui/{domain}.md` | `ui/index.md` if new page |
|
|
173
|
+
| Architecture decision | `${paths.adrs_dir}/ADR-*.md` | `agents/architecture.md` |
|
|
174
|
+
| Workflow/process | `agents/workflows.md` | `AGENTS.md` if MUST rule |
|
|
175
|
+
| Security policy | `agents/security.md` | ADR if major change |
|
|
176
|
+
| Testing approach | `agents/testing.md` | - |
|
|
177
|
+
| Environment setup | `agents/runbook.md` | - |
|
|
178
|
+
| Project status | `${paths.references_dir}/project-status.md` | - |
|
|
179
|
+
|
|
180
|
+
---
|
|
181
|
+
|
|
182
|
+
## Realistic Examples
|
|
183
|
+
|
|
184
|
+
### Example 1: Adding a new API endpoint
|
|
185
|
+
|
|
186
|
+
You add `POST /api/v1/users/favorites`:
|
|
187
|
+
|
|
188
|
+
1. Determine module: User-related --> `users.md` or `customer.md`
|
|
189
|
+
2. Add endpoint documentation following the standard format
|
|
190
|
+
3. Update `api/index.md` endpoint count if needed
|
|
191
|
+
4. Update `data-model.md` if new database fields
|
|
192
|
+
5. Commit: `[FEAT-XXX] Add favorites endpoint with docs`
|
|
193
|
+
|
|
194
|
+
### Example 2: Changing database schema
|
|
195
|
+
|
|
196
|
+
You add a `lastLoginAt` field to the `users` table/collection:
|
|
197
|
+
|
|
198
|
+
1. Update `${paths.references_dir}/data-model.md` with new field
|
|
199
|
+
2. Check if any API endpoints need doc updates
|
|
200
|
+
3. No ADR needed (field addition is non-breaking)
|
|
201
|
+
4. Commit: `[FEAT-XXX] Add lastLoginAt field to users`
|
|
202
|
+
|
|
203
|
+
### Example 3: Architectural decision
|
|
204
|
+
|
|
205
|
+
You decide to use Redis for caching:
|
|
206
|
+
|
|
207
|
+
1. Create `${paths.adrs_dir}/ADR-20260123-redis-caching.md`
|
|
208
|
+
2. Update `agents/architecture.md` with caching strategy
|
|
209
|
+
3. Update `agents/runbook.md` with Redis setup
|
|
210
|
+
4. Update backlog card with decision
|
|
211
|
+
5. Commit: `[FEAT-XXX] Add Redis caching with ADR`
|
|
212
|
+
|
|
213
|
+
---
|
|
214
|
+
|
|
215
|
+
## Navigation Tips
|
|
216
|
+
|
|
217
|
+
1. **Start here**: If unsure where to look, start with `agents/index.md` (this file)
|
|
218
|
+
2. **API changes**: Always check `agents/api-contracts.md` for rules before modifying API docs
|
|
219
|
+
3. **Data model**: Cross-reference with `api/*.md` modules when updating
|
|
220
|
+
4. **Legacy context**: Check `archive/project_full_legacy.md` for historical decisions if it exists
|
|
221
|
+
5. **Status check**: `${paths.references_dir}/project-status.md` shows current work and blockers
|
|
222
|
+
|
|
223
|
+
---
|
|
224
|
+
|
|
225
|
+
## Documentation Size Budget
|
|
226
|
+
|
|
227
|
+
### File Size Thresholds
|
|
228
|
+
|
|
229
|
+
| Doc Type | Max Lines | Action When Exceeded |
|
|
230
|
+
|----------|-----------|---------------------|
|
|
231
|
+
| Agent modules (agents/*.md) | 300 | Split into sub-modules |
|
|
232
|
+
| Reference docs (${paths.references_dir}/*) | 300 | Split by topic/collection |
|
|
233
|
+
| API docs | 400 | Split by endpoint group |
|
|
234
|
+
| PRDs/Specs | 500 | Split into requirements + implementation |
|
|
235
|
+
| project-status.md | 200 | Archive to work-history.md |
|
|
236
|
+
|
|
237
|
+
### When to Split a File
|
|
238
|
+
|
|
239
|
+
1. File exceeds threshold by 50%+
|
|
240
|
+
2. File mixes doc-types (tutorial + reference + how-to)
|
|
241
|
+
3. File has 3+ distinct topics that could standalone
|
|
242
|
+
4. Agents report context loading issues
|
|
243
|
+
|
|
244
|
+
### Token Efficiency Guidelines
|
|
245
|
+
|
|
246
|
+
- Compress verbose cross-references: "See [X](link)." not "See the X documentation for details."
|
|
247
|
+
- Use tables over bullet lists for structured data
|
|
248
|
+
- Remove boilerplate (Purpose/Scope can be 1 line)
|
|
249
|
+
- Link don't duplicate - one source of truth per fact
|
|
250
|
+
|
|
251
|
+
---
|
|
252
|
+
|
|
253
|
+
## References
|
|
254
|
+
|
|
255
|
+
- `${paths.references_dir}/product-scope.md`
|
|
256
|
+
- `${paths.references_dir}/data-model.md`
|
|
257
|
+
- `${paths.references_dir}/api/index.md` (API reference - organize by domain)
|
|
258
|
+
- `${paths.references_dir}/ui/index.md` (UI routes - organize by domain)
|
|
259
|
+
- `${paths.references_dir}/project-status.md`
|
|
260
|
+
- `docs/operations/` (operational procedures - if applicable)
|
|
261
|
+
- `${paths.adrs_dir}/`
|