agentic-sdlc 1.0.0 → 1.5.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/.agent/ide-integration/INTEGRATION-SUMMARY.md +309 -0
- package/.agent/ide-integration/KIRO-IDE.md +381 -0
- package/.agent/ide-integration/README.md +256 -209
- package/.agent/knowledge-base/AUTO-LEARNING-GUIDE.md +327 -0
- package/.agent/knowledge-base/HOW-IT-WORKS.md +365 -0
- package/.agent/knowledge-base/INDEX.md +43 -0
- package/.agent/knowledge-base/README.md +47 -7
- package/.agent/knowledge-base/architecture/KB-2026-01-01-003-neo4j-graph-database-skills.md +1146 -0
- package/.agent/knowledge-base/architecture/README.md +98 -0
- package/.agent/knowledge-base/bugs/KB-2026-01-02-yaml-special-character-escaping.md +56 -0
- package/.agent/knowledge-base/bugs/medium/KB-2026-01-01-001-example-auto-learned.md +198 -0
- package/.agent/knowledge-base/features/KB-2026-01-01-001-landing-page-design-trends-2026.md +646 -0
- package/.agent/knowledge-base/features/KB-2026-01-01-004-uiux-design-skills-2026.md +945 -0
- package/.agent/knowledge-base/features/KB-2026-01-01-005-modern-ai-landing-page-ui.md +310 -0
- package/.agent/knowledge-base/features/KB-2026-01-01-006-award-winning-landing-page-patterns.md +324 -0
- package/.agent/knowledge-base/features/KB-2026-01-02-001-cleanup-workflow.md +242 -0
- package/.agent/knowledge-base/features/KB-2026-01-02-002-landing-page-monorepo-architecture.md +148 -0
- package/.agent/knowledge-base/features/KB-2026-01-02-003-premium-glassmorphism-patterns.md +58 -0
- package/.agent/knowledge-base/features/KB-2026-01-04-ai-agent-enforcement.md +46 -0
- package/.agent/knowledge-base/features/README.md +83 -0
- package/.agent/knowledge-base/features/figma-landing-page-workflow.md +311 -0
- package/.agent/knowledge-base/features/figma-mcp-sa-guide.md +673 -0
- package/.agent/knowledge-base/features/figma-mcp-uiux-guide.md +459 -0
- package/.agent/knowledge-base/performance/KB-2026-01-02-lazy-loading-optimization.md +80 -0
- package/.agent/knowledge-base/platform-specific/KB-2026-01-02-windows-console-encoding.md +56 -0
- package/.agent/knowledge-base/role-guides/DEV-KB-Guide.md +527 -0
- package/.agent/knowledge-base/role-guides/DEVOPS-KB-Guide.md +491 -0
- package/.agent/knowledge-base/role-guides/PM-KB-Guide.md +299 -0
- package/.agent/knowledge-base/role-guides/SECA-KB-Guide.md +555 -0
- package/.agent/knowledge-base/role-guides/TESTER-KB-Guide.md +519 -0
- package/.agent/knowledge-base/security/KB-2026-01-02-input-validation-sanitization.md +74 -0
- package/.agent/rules/AUTO-LEARNING.md +418 -0
- package/.agent/rules/ai-enforcement.md +11 -0
- package/.agent/rules/artifacts.md +77 -58
- package/.agent/rules/git-workflow.md +25 -65
- package/.agent/rules/global.md +18 -13
- package/.agent/skills/role-ba.md +76 -0
- package/.agent/skills/role-brain.md +470 -0
- package/.agent/skills/role-dev.md +338 -0
- package/.agent/skills/role-devops.md +122 -0
- package/.agent/skills/role-orchestrator.md +223 -0
- package/.agent/skills/role-pm.md +258 -0
- package/.agent/skills/role-po.md +237 -0
- package/.agent/skills/role-qa.md +81 -0
- package/.agent/skills/role-reporter.md +117 -0
- package/.agent/skills/role-sa.md +277 -0
- package/.agent/skills/role-seca.md +294 -0
- package/.agent/skills/role-stakeholder.md +105 -0
- package/.agent/skills/role-tester.md +294 -0
- package/.agent/skills/role-uiux.md +264 -0
- package/.agent/templates/CHANGELOG-Template.md +83 -0
- package/.agent/templates/Knowledge-Entry-Template.md +3 -0
- package/.agent/workflows/brain.md +84 -53
- package/.agent/workflows/compound.md +51 -0
- package/.agent/workflows/cycle.md +61 -0
- package/.agent/workflows/emergency.md +114 -0
- package/.agent/workflows/explore.md +147 -0
- package/.agent/workflows/housekeeping.md +105 -0
- package/.agent/workflows/metrics.md +179 -0
- package/.agent/workflows/orchestrator.md +68 -0
- package/.agent/workflows/preflight.md +35 -0
- package/.agent/workflows/release.md +153 -0
- package/.agent/workflows/route.md +160 -0
- package/.agent/workflows/sprint.md +125 -0
- package/.agent/workflows/validate.md +146 -0
- package/CHANGELOG.md +349 -6
- package/README.md +171 -86
- package/bin/CROSS-PLATFORM-CLI.md +526 -0
- package/bin/README.md +525 -0
- package/bin/cli.js +65 -90
- package/bin/kb +34 -0
- package/bin/kb.bat +28 -0
- package/bin/kb_cli.py +226 -0
- package/bin/lib/README.md +411 -0
- package/bin/lib/__init__.py +7 -0
- package/bin/lib/__pycache__/kb_add.cpython-313.pyc +0 -0
- package/bin/lib/__pycache__/kb_common.cpython-313.pyc +0 -0
- package/bin/lib/__pycache__/kb_compound.cpython-313.pyc +0 -0
- package/bin/lib/__pycache__/kb_index.cpython-313.pyc +0 -0
- package/bin/lib/__pycache__/kb_list.cpython-313.pyc +0 -0
- package/bin/lib/__pycache__/kb_search.cpython-313.pyc +0 -0
- package/bin/lib/__pycache__/kb_stats.cpython-313.pyc +0 -0
- package/bin/lib/kb_add.py +203 -0
- package/bin/lib/kb_common.py +224 -0
- package/bin/lib/kb_compound.py +250 -0
- package/bin/lib/kb_index.py +193 -0
- package/bin/lib/kb_list.py +144 -0
- package/bin/lib/kb_search.py +121 -0
- package/bin/lib/kb_stats.py +153 -0
- package/docs/AGENT-MANAGEMENT-GUIDE.md +298 -0
- package/docs/ARCHITECTURE-OVERVIEW.md +350 -0
- package/docs/BRAIN-ARCHITECTURE.md +396 -0
- package/docs/COMPOUND-ENGINEERING-SETUP.md +326 -0
- package/docs/KNOWLEDGE-BASE-GUIDE.md +330 -0
- package/docs/KNOWLEDGE-BASE-SIMPLE.md +248 -0
- package/docs/MONOREPO-ARCHITECTURE.md +492 -0
- package/docs/PROJECT-DOCUMENTATION-INDEX.md +540 -0
- package/docs/SDLC-Diagram.md +235 -0
- package/docs/analysis/Workflow-Optimization-Diagram.md +524 -0
- package/docs/analysis/Workflows-Deep-Analysis-2026-01-03.md +604 -0
- package/docs/architecture/{brain.md → BRAIN.md} +1 -1
- package/docs/global/Master-Documentation.md +307 -0
- package/docs/global/reports/Final-Approval-Report.md +257 -0
- package/docs/guides/AUTO-LEARNING-COMPLETE-GUIDE.md +519 -0
- package/docs/guides/AUTO-LEARNING-SYSTEM.md +322 -0
- package/docs/guides/LEARNING-FLOW.md +0 -0
- package/docs/guides/MCP-QUICK-REFERENCE.md +104 -0
- package/docs/guides/MCP-SETUP.md +139 -0
- package/docs/guides/QUICK-START.md +4 -0
- package/docs/guides/ROLE-COMMUNICATION-SYSTEM.md +71 -0
- package/docs/reports/Metrics-Dashboard-2026-01-02.md +66 -0
- package/docs/reports/Metrics-Dashboard-2026-01-04.md +68 -0
- package/docs/reports/UIUX-Design-Skills-Research-Report-2026.md +91 -0
- package/docs/reports/Validation-Report-2026-01-04.md +23 -0
- package/docs/research-reports/research-20260103-101315.json +95 -0
- package/docs/research-reports/research-20260103-101315.md +78 -0
- package/docs/research-reports/research-20260103-183837.json +95 -0
- package/docs/research-reports/research-20260103-183837.md +78 -0
- package/docs/research-reports/research-20260103-190346.json +100 -0
- package/docs/research-reports/research-20260103-190346.md +83 -0
- package/docs/setup/{github-management.md → GITHUB-MANAGEMENT.md} +1 -1
- package/docs/setup/RESEARCH-AGENT-SETUP.md +575 -0
- package/docs/sprints/{sprint-github-issues.md → SPRINT-GITHUB-ISSUES.md} +1 -1
- package/docs/sprints/{sprint-leann-integration.md → SPRINT-LEANN-INTEGRATION.md} +1 -1
- package/docs/sprints/sprint-1/designs/Backend-Design-Spec-Sprint-1-v1.md +1206 -0
- package/docs/sprints/sprint-1/designs/System-Design-Spec-Sprint-1-v1.md +439 -0
- package/docs/sprints/sprint-1/designs/System-Design-Spec-v1.0.md +425 -0
- package/docs/sprints/sprint-1/designs/UIUX-Design-Spec-Sprint-1-v1.md +55 -0
- package/docs/sprints/sprint-1/designs/UIUX-Design-Spec-v1.0.md +644 -0
- package/docs/sprints/sprint-1/logs/DevOps-Plan-and-Log-Sprint-1-v1.md +253 -0
- package/docs/sprints/sprint-1/logs/Development-Log-Phase1.md +433 -0
- package/docs/sprints/sprint-1/logs/Development-Log-Sprint-1-v1.md +181 -0
- package/docs/sprints/sprint-1/logs/Development-Log-Sprint-1.md +548 -0
- package/docs/sprints/sprint-1/logs/Orchestration-Log-Sprint-1.md +46 -0
- package/docs/sprints/sprint-1/logs/Phase1-Summary.md +84 -0
- package/docs/sprints/sprint-1/plans/Product-Backlog-Sprint-1-v1.md +40 -0
- package/docs/sprints/sprint-1/plans/Product-Backlog-v1.0.md +613 -0
- package/docs/sprints/sprint-1/plans/Project-Plan-Sprint-1-v1.0.md +210 -0
- package/docs/sprints/sprint-1/plans/Project-Plan-Sprint-1-v1.md +377 -0
- package/docs/sprints/sprint-1/reports/Design-Verification-Report-v1.0.md +220 -0
- package/docs/sprints/sprint-1/reports/Phase-Report-Sprint-1-v1.md +238 -0
- package/docs/sprints/sprint-1/reports/Security-Review-Report-v1.0.md +285 -0
- package/docs/sprints/sprint-1/reports/Sprint-Report-Sprint-1.md +74 -0
- package/docs/sprints/sprint-1/reports/Test-Report-v1.0.md +346 -0
- package/docs/sprints/sprint-1/reviews/Design-Verification-Report.md +508 -0
- package/docs/sprints/sprint-1/reviews/Security-Review-Report.md +589 -0
- package/docs/sprints/sprint-1/sprint-current/logs/WORKFLOW-CLEANUP-FINAL.md +121 -0
- package/docs/sprints/sprint-1/sprint-current/logs/WORKFLOW-OPTIMIZATION-COMPLETE.md +224 -0
- package/docs/sprints/sprint-1/sprint-current/logs/Workflow-Optimization-Progress.md +310 -0
- package/docs/sprints/sprint-1/sprint-current/logs/Workflow-Optimization-Session-Summary.md +420 -0
- package/docs/sprints/sprint-1/sprint-current/plans/Workflow-Optimization-Implementation-Plan.md +1124 -0
- package/docs/sprints/sprint-2/SPRINT-SUMMARY.md +150 -0
- package/docs/sprints/sprint-2/designs/UIUX-Design-Spec-Sprint-2-v1.md +352 -0
- package/docs/sprints/sprint-2/logs/Development-Log-Sprint-2-v1.md +293 -0
- package/docs/sprints/sprint-2/plans/Product-Backlog-Sprint-2-v1.md +62 -0
- package/docs/sprints/sprint-2/plans/Project-Plan-Sprint-2-v1.md +228 -0
- package/docs/sprints/sprint-2/reports/Phase-Report-Sprint-2-v1.md +303 -0
- package/docs/sprints/sprint-3/designs/UIUX-Design-Spec-Sprint-3-v1.md +160 -0
- package/docs/sprints/sprint-3/logs/Development-Log-Sprint-3-v1.md +249 -0
- package/docs/sprints/sprint-3/logs/Testing-Report-Sprint-3-v1.md +244 -0
- package/docs/sprints/sprint-3/plans/Product-Backlog-Sprint-3-v1.md +95 -0
- package/docs/sprints/sprint-3/reports/Final-Approval-Report-Sprint-3-v1.md +299 -0
- package/docs/sprints/sprint-3/reports/Sprint-Summary-Sprint-3-v1.md +276 -0
- package/docs/sprints/sprint-3/reviews/Design-Verification-Report-Sprint-3-v1.md +122 -0
- package/docs/sprints/sprint-3/reviews/Security-Review-Report-Sprint-3-v1.md +67 -0
- package/docs/sprints/sprint-5/designs/Backend-Design-Spec-Sprint-5-v1.md +1734 -0
- package/docs/sprints/sprint-5/designs/Design-Verification-Report.md +101 -0
- package/docs/sprints/sprint-5/designs/Security-Review-Report.md +84 -0
- package/docs/sprints/sprint-6/.brain-state.json +29 -0
- package/package.json +92 -16
- package/.agent/ide-integration/aider-commands.md +0 -40
- package/.agent/ide-integration/cline-config.json +0 -108
- package/.agent/ide-integration/cursor-rules.md +0 -63
- package/.agent/ide-integration/github-copilot-instructions.md +0 -75
- package/.agent/ide-integration/vscode-commands.json +0 -190
- package/.agent/ide-integration/windsurf-cascade.md +0 -125
- package/.agent/knowledge-base/index.md +0 -202
- package/.agent/legacy/roles/designer.md +0 -311
- package/.agent/legacy/roles/dev.md +0 -177
- package/.agent/legacy/roles/devops.md +0 -146
- package/.agent/legacy/roles/orchestrator.md +0 -339
- package/.agent/legacy/roles/pm.md +0 -120
- package/.agent/legacy/roles/po.md +0 -89
- package/.agent/legacy/roles/qa.md +0 -108
- package/.agent/legacy/roles/reporter.md +0 -70
- package/.agent/legacy/roles/sa.md +0 -118
- package/.agent/legacy/roles/seca.md +0 -112
- package/.agent/legacy/roles/stakeholder.md +0 -111
- package/.agent/legacy/roles/tester.md +0 -129
- package/.agent/rules/global.md.bak +0 -154
- package/.agent/usage.md +0 -653
- package/.agent/workflows/auto.md +0 -35
- package/.agent/workflows/dev.md +0 -30
- package/.agent/workflows/devops.md +0 -28
- package/.agent/workflows/kb-search.md +0 -22
- package/.agent/workflows/pm.md +0 -42
- package/.agent/workflows/po.md +0 -21
- package/.agent/workflows/qa.md +0 -31
- package/.agent/workflows/reporter.md +0 -21
- package/.agent/workflows/sa.md +0 -51
- package/.agent/workflows/seca.md +0 -21
- package/.agent/workflows/stakeholder.md +0 -26
- package/.agent/workflows/tester.md +0 -21
- package/.agent/workflows/uiux.md +0 -38
- package/.cursorrules +0 -49
- package/.env.template +0 -10
- package/.github/ISSUE_TEMPLATE/bug_report.yml +0 -47
- package/.github/ISSUE_TEMPLATE/config.yml +0 -8
- package/.github/ISSUE_TEMPLATE/feature_request.yml +0 -33
- package/.github/ISSUE_TEMPLATE/security_alert.yml +0 -28
- package/.github/ISSUE_TEMPLATE/task_implementation.yml +0 -37
- package/.github/copilot-instructions.md +0 -60
- package/bin/commands/create.js +0 -96
- package/bin/commands/help.js +0 -69
- package/bin/commands/ide.js +0 -116
- package/bin/commands/init-kb.js +0 -74
- package/bin/commands/install.js +0 -68
- package/bin/commands/list.js +0 -35
- package/bin/graph_brain.py +0 -86
- package/bin/sync_github.py +0 -75
- package/bin/utils/args-parser.js +0 -33
- package/bin/utils/colors.js +0 -21
- package/bin/verify_neo4j.py +0 -25
- /package/.agent/rules/{knowledge-base.md → KNOWLEDGE-BASE.md} +0 -0
- /package/docs/architecture/{neo4j-learning-queries.md → NEO4J-LEARNING-QUERIES.md} +0 -0
- /package/docs/reports/{comparison-leann-neo4j.md → COMPARISON-LEANN-NEO4J.md} +0 -0
- /package/docs/sprints/{sprint-neo4j-brain.md → SPRINT-NEO4J-BRAIN.md} +0 -0
|
@@ -0,0 +1,418 @@
|
|
|
1
|
+
# 🧠 Automatic Knowledge Base Learning System
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
This system automatically captures and stores knowledge from every task, issue, and bug fix to build project intelligence over time.
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## 🔄 Auto-Learning Triggers
|
|
9
|
+
|
|
10
|
+
### Mandatory Knowledge Capture
|
|
11
|
+
The following events **MUST** trigger automatic knowledge base entry creation:
|
|
12
|
+
|
|
13
|
+
| Event | Trigger Condition | Auto-Create Entry |
|
|
14
|
+
|-------|------------------|-------------------|
|
|
15
|
+
| **Bug Fixed** | Any bug with priority medium+ | ✅ Yes |
|
|
16
|
+
| **Multiple Attempts** | Task required 3+ attempts | ✅ Yes |
|
|
17
|
+
| **Error Pattern** | Same error occurred 2+ times | ✅ Yes |
|
|
18
|
+
| **Complex Feature** | Implementation took 4+ hours | ✅ Yes |
|
|
19
|
+
| **Security Issue** | Any security vulnerability found | ✅ Yes |
|
|
20
|
+
| **Performance Fix** | Performance optimization applied | ✅ Yes |
|
|
21
|
+
| **Integration Issue** | Third-party integration problem | ✅ Yes |
|
|
22
|
+
| **Platform Issue** | Platform-specific problem solved | ✅ Yes |
|
|
23
|
+
| **Architecture Decision** | Major design decision made | ✅ Yes |
|
|
24
|
+
| **Rollback Event** | Deployment rolled back | ✅ Yes |
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## 📝 Auto-Learning Workflow
|
|
29
|
+
|
|
30
|
+
### Step 1: Detection (Automatic)
|
|
31
|
+
When any agent completes a task, they MUST check if it meets learning criteria:
|
|
32
|
+
|
|
33
|
+
```markdown
|
|
34
|
+
### Knowledge Base Check
|
|
35
|
+
- [ ] Bug priority: [critical/high/medium/low]
|
|
36
|
+
- [ ] Attempts required: [number]
|
|
37
|
+
- [ ] Similar issues before: [yes/no]
|
|
38
|
+
- [ ] Implementation complexity: [simple/moderate/complex]
|
|
39
|
+
- [ ] Security impact: [yes/no]
|
|
40
|
+
- [ ] Performance impact: [yes/no]
|
|
41
|
+
|
|
42
|
+
**Auto-Learn Required:** [YES/NO]
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Step 2: Capture (Automatic)
|
|
46
|
+
If auto-learn is required, immediately create knowledge entry:
|
|
47
|
+
|
|
48
|
+
```markdown
|
|
49
|
+
## Auto-Generated Knowledge Entry
|
|
50
|
+
|
|
51
|
+
**Entry ID:** KB-[YYYY-MM-DD]-[###]-[auto-title]
|
|
52
|
+
**Category:** [bugs/features/architecture/security/performance/platform]
|
|
53
|
+
**Severity:** [critical/high/medium/low]
|
|
54
|
+
**Auto-Generated:** Yes
|
|
55
|
+
**Source:** [Task ID / Issue ID / Bug ID]
|
|
56
|
+
|
|
57
|
+
### Problem
|
|
58
|
+
[Auto-extracted from task description]
|
|
59
|
+
|
|
60
|
+
### Context
|
|
61
|
+
- Sprint: [N]
|
|
62
|
+
- Component: [name]
|
|
63
|
+
- Technology: [stack]
|
|
64
|
+
- Platform: [web/mobile/desktop/cli]
|
|
65
|
+
|
|
66
|
+
### Solution Applied
|
|
67
|
+
[Auto-extracted from implementation]
|
|
68
|
+
|
|
69
|
+
### Root Cause
|
|
70
|
+
[To be filled by agent]
|
|
71
|
+
|
|
72
|
+
### Prevention
|
|
73
|
+
[To be filled by agent]
|
|
74
|
+
|
|
75
|
+
### Tags
|
|
76
|
+
#auto-learned #[category] #[technology] #[severity]
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Step 3: Index Update (Automatic)
|
|
80
|
+
Automatically update `knowledge-base/index.md`:
|
|
81
|
+
|
|
82
|
+
```markdown
|
|
83
|
+
| KB-[date]-[###] | [Title] | [Category] | [Severity] | [Tags] | [Date] | Auto |
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### Step 4: Cross-Reference (Automatic)
|
|
87
|
+
Link to related entries:
|
|
88
|
+
- Search for similar keywords
|
|
89
|
+
- Link to related bugs/features
|
|
90
|
+
- Update related entries with new insights
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## 🎯 Role-Specific Auto-Learning
|
|
95
|
+
|
|
96
|
+
### @DEV - Development Learning
|
|
97
|
+
**Auto-capture when:**
|
|
98
|
+
- Bug fixed (any priority)
|
|
99
|
+
- Code refactoring completed
|
|
100
|
+
- Performance optimization applied
|
|
101
|
+
- Integration implemented
|
|
102
|
+
|
|
103
|
+
**Knowledge Type:** Code patterns, bug fixes, optimizations
|
|
104
|
+
|
|
105
|
+
### @DEVOPS - Infrastructure Learning
|
|
106
|
+
**Auto-capture when:**
|
|
107
|
+
- Deployment issue resolved
|
|
108
|
+
- Configuration changed
|
|
109
|
+
- Infrastructure scaled
|
|
110
|
+
- Monitoring alert triggered
|
|
111
|
+
|
|
112
|
+
**Knowledge Type:** Deployment patterns, infrastructure issues
|
|
113
|
+
|
|
114
|
+
### @TESTER - Testing Learning
|
|
115
|
+
**Auto-capture when:**
|
|
116
|
+
- Test failure pattern identified
|
|
117
|
+
- Edge case discovered
|
|
118
|
+
- Test automation challenge solved
|
|
119
|
+
- Regression bug found
|
|
120
|
+
|
|
121
|
+
**Knowledge Type:** Test patterns, edge cases, regression patterns
|
|
122
|
+
|
|
123
|
+
### @SECA - Security Learning
|
|
124
|
+
**Auto-capture when:**
|
|
125
|
+
- Security vulnerability found
|
|
126
|
+
- Security scan issue resolved
|
|
127
|
+
- Authentication/authorization issue fixed
|
|
128
|
+
- Data protection measure implemented
|
|
129
|
+
|
|
130
|
+
**Knowledge Type:** Security vulnerabilities, attack patterns, fixes
|
|
131
|
+
|
|
132
|
+
### @SA - Architecture Learning
|
|
133
|
+
**Auto-capture when:**
|
|
134
|
+
- Architecture decision made
|
|
135
|
+
- Design pattern applied
|
|
136
|
+
- Scalability issue addressed
|
|
137
|
+
- Technology choice made
|
|
138
|
+
|
|
139
|
+
**Knowledge Type:** Architecture patterns, design decisions
|
|
140
|
+
|
|
141
|
+
### @UIUX - Design Learning
|
|
142
|
+
**Auto-capture when:**
|
|
143
|
+
- UX issue identified and fixed
|
|
144
|
+
- Accessibility improvement made
|
|
145
|
+
- Design pattern applied
|
|
146
|
+
- User feedback incorporated
|
|
147
|
+
|
|
148
|
+
**Knowledge Type:** UX patterns, accessibility solutions
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
152
|
+
## 🤖 Automated Knowledge Entry Template
|
|
153
|
+
|
|
154
|
+
Every agent MUST use this template for auto-learning:
|
|
155
|
+
|
|
156
|
+
```markdown
|
|
157
|
+
---
|
|
158
|
+
id: KB-[YYYY-MM-DD]-[###]
|
|
159
|
+
title: [Auto-Generated Title]
|
|
160
|
+
category: [bugs/features/architecture/security/performance/platform]
|
|
161
|
+
severity: [critical/high/medium/low]
|
|
162
|
+
auto-generated: true
|
|
163
|
+
source-task: [Task/Issue/Bug ID]
|
|
164
|
+
sprint: [N]
|
|
165
|
+
date: [YYYY-MM-DD]
|
|
166
|
+
author: [@ROLE]
|
|
167
|
+
tags: [#tag1, #tag2, #tag3]
|
|
168
|
+
---
|
|
169
|
+
|
|
170
|
+
# [Title]
|
|
171
|
+
|
|
172
|
+
## 📋 Metadata
|
|
173
|
+
- **Entry ID:** KB-[YYYY-MM-DD]-[###]
|
|
174
|
+
- **Category:** [Category]
|
|
175
|
+
- **Severity:** [Severity]
|
|
176
|
+
- **Sprint:** [N]
|
|
177
|
+
- **Date:** [YYYY-MM-DD]
|
|
178
|
+
- **Author:** [@ROLE]
|
|
179
|
+
- **Source:** [Task/Issue/Bug ID]
|
|
180
|
+
- **Auto-Generated:** Yes
|
|
181
|
+
|
|
182
|
+
## 🔍 Problem Description
|
|
183
|
+
[Clear description of the problem encountered]
|
|
184
|
+
|
|
185
|
+
## 🌍 Context
|
|
186
|
+
- **Component:** [Component name]
|
|
187
|
+
- **Technology:** [Tech stack]
|
|
188
|
+
- **Platform:** [web/mobile/desktop/cli]
|
|
189
|
+
- **Environment:** [dev/staging/production]
|
|
190
|
+
- **Related Files:** [List of files]
|
|
191
|
+
|
|
192
|
+
## 🚨 Symptoms
|
|
193
|
+
- [Symptom 1]
|
|
194
|
+
- [Symptom 2]
|
|
195
|
+
- [Symptom 3]
|
|
196
|
+
|
|
197
|
+
## 🔬 Root Cause Analysis
|
|
198
|
+
[Detailed explanation of why the issue occurred]
|
|
199
|
+
|
|
200
|
+
## ✅ Solution Applied
|
|
201
|
+
[Step-by-step solution that worked]
|
|
202
|
+
|
|
203
|
+
```code
|
|
204
|
+
[Code snippets if applicable]
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
## 🛡️ Prevention Measures
|
|
208
|
+
- [ ] [Prevention measure 1]
|
|
209
|
+
- [ ] [Prevention measure 2]
|
|
210
|
+
- [ ] [Prevention measure 3]
|
|
211
|
+
|
|
212
|
+
## 📊 Impact Assessment
|
|
213
|
+
- **Severity:** [critical/high/medium/low]
|
|
214
|
+
- **Affected Users:** [number/percentage]
|
|
215
|
+
- **Downtime:** [duration]
|
|
216
|
+
- **Data Loss:** [yes/no]
|
|
217
|
+
|
|
218
|
+
## 🔗 Related Entries
|
|
219
|
+
- [KB-YYYY-MM-DD-###] - [Related entry title]
|
|
220
|
+
- [KB-YYYY-MM-DD-###] - [Related entry title]
|
|
221
|
+
|
|
222
|
+
## 📚 References
|
|
223
|
+
- [Documentation link]
|
|
224
|
+
- [Stack Overflow link]
|
|
225
|
+
- [GitHub issue link]
|
|
226
|
+
|
|
227
|
+
## 🏷️ Tags
|
|
228
|
+
#auto-learned #[category] #[technology] #[severity] #sprint-[N]
|
|
229
|
+
|
|
230
|
+
---
|
|
231
|
+
*Auto-generated by @[ROLE] on [YYYY-MM-DD]*
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
---
|
|
235
|
+
|
|
236
|
+
## 🔍 Auto-Search Before Starting
|
|
237
|
+
|
|
238
|
+
Before starting ANY task, agents MUST:
|
|
239
|
+
|
|
240
|
+
1. **Search Knowledge Base**
|
|
241
|
+
```markdown
|
|
242
|
+
### Knowledge Base Search
|
|
243
|
+
- Keywords: [list keywords]
|
|
244
|
+
- Category: [category]
|
|
245
|
+
- Technology: [tech]
|
|
246
|
+
- Results: [number] entries found
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
2. **Review Relevant Entries**
|
|
250
|
+
- Read top 3 most relevant entries
|
|
251
|
+
- Check for similar patterns
|
|
252
|
+
- Adapt solutions to current context
|
|
253
|
+
|
|
254
|
+
3. **Document Search Results**
|
|
255
|
+
```markdown
|
|
256
|
+
### KB Search Results
|
|
257
|
+
- **KB-[date]-[###]:** [Title] - [Relevance: high/medium/low]
|
|
258
|
+
- **KB-[date]-[###]:** [Title] - [Relevance: high/medium/low]
|
|
259
|
+
- **Applicable Solutions:** [yes/no]
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
---
|
|
263
|
+
|
|
264
|
+
## 📈 Learning Metrics
|
|
265
|
+
|
|
266
|
+
Track these metrics in `knowledge-base/index.md`:
|
|
267
|
+
|
|
268
|
+
| Metric | Description | Target |
|
|
269
|
+
|--------|-------------|--------|
|
|
270
|
+
| **Total Entries** | Number of KB entries | Growing |
|
|
271
|
+
| **Auto-Generated** | Percentage auto-created | >80% |
|
|
272
|
+
| **Reuse Rate** | Entries referenced in tasks | >50% |
|
|
273
|
+
| **Resolution Time** | Average time to fix similar issues | Decreasing |
|
|
274
|
+
| **Recurrence Rate** | Same issue occurring again | <10% |
|
|
275
|
+
|
|
276
|
+
---
|
|
277
|
+
|
|
278
|
+
## 🎯 Quality Standards for Auto-Learning
|
|
279
|
+
|
|
280
|
+
Every auto-generated entry MUST include:
|
|
281
|
+
|
|
282
|
+
- ✅ Clear problem description
|
|
283
|
+
- ✅ Reproducible steps (if applicable)
|
|
284
|
+
- ✅ Root cause analysis
|
|
285
|
+
- ✅ Working solution with code
|
|
286
|
+
- ✅ Prevention measures
|
|
287
|
+
- ✅ Proper categorization
|
|
288
|
+
- ✅ Relevant tags
|
|
289
|
+
- ✅ Cross-references
|
|
290
|
+
|
|
291
|
+
---
|
|
292
|
+
|
|
293
|
+
## 🔄 Continuous Improvement
|
|
294
|
+
|
|
295
|
+
### Weekly Review
|
|
296
|
+
Every Friday, @REPORTER MUST:
|
|
297
|
+
1. Review all auto-generated entries from the week
|
|
298
|
+
2. Verify completeness and quality
|
|
299
|
+
3. Add missing details
|
|
300
|
+
4. Update cross-references
|
|
301
|
+
5. Archive duplicates
|
|
302
|
+
|
|
303
|
+
### Monthly Analysis
|
|
304
|
+
Every month-end, @REPORTER MUST:
|
|
305
|
+
1. Analyze learning metrics
|
|
306
|
+
2. Identify knowledge gaps
|
|
307
|
+
3. Consolidate similar entries
|
|
308
|
+
4. Update index and categories
|
|
309
|
+
5. Generate learning report
|
|
310
|
+
|
|
311
|
+
### Quarterly Optimization
|
|
312
|
+
Every quarter, @PM + @REPORTER MUST:
|
|
313
|
+
1. Review entire knowledge base
|
|
314
|
+
2. Archive outdated entries
|
|
315
|
+
3. Refactor categories if needed
|
|
316
|
+
4. Update templates
|
|
317
|
+
5. Train team on new patterns
|
|
318
|
+
|
|
319
|
+
---
|
|
320
|
+
|
|
321
|
+
## 🚀 Integration with Workflow
|
|
322
|
+
|
|
323
|
+
### In Development Log
|
|
324
|
+
```markdown
|
|
325
|
+
## Knowledge Base Integration
|
|
326
|
+
- **KB Entries Created:** [number]
|
|
327
|
+
- **KB Entries Referenced:** [number]
|
|
328
|
+
- **New Patterns Learned:** [list]
|
|
329
|
+
- **Prevention Measures Applied:** [list]
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
### In Test Report
|
|
333
|
+
```markdown
|
|
334
|
+
## Knowledge Base Integration
|
|
335
|
+
- **Test Patterns Learned:** [list]
|
|
336
|
+
- **Edge Cases Documented:** [number]
|
|
337
|
+
- **Regression Patterns:** [list]
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
### In Phase Report
|
|
341
|
+
```markdown
|
|
342
|
+
## Knowledge Base Summary
|
|
343
|
+
- **Total KB Entries:** [number]
|
|
344
|
+
- **Categories:** [breakdown]
|
|
345
|
+
- **Most Referenced:** [top 3]
|
|
346
|
+
- **Learning Impact:** [description]
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
---
|
|
350
|
+
|
|
351
|
+
## 🎓 Learning Categories
|
|
352
|
+
|
|
353
|
+
### 1. Bug Patterns
|
|
354
|
+
- Error messages and solutions
|
|
355
|
+
- Common mistakes
|
|
356
|
+
- Edge cases
|
|
357
|
+
- Regression patterns
|
|
358
|
+
|
|
359
|
+
### 2. Feature Patterns
|
|
360
|
+
- Implementation approaches
|
|
361
|
+
- Design patterns
|
|
362
|
+
- Best practices
|
|
363
|
+
- Anti-patterns to avoid
|
|
364
|
+
|
|
365
|
+
### 3. Architecture Patterns
|
|
366
|
+
- Design decisions
|
|
367
|
+
- Scalability solutions
|
|
368
|
+
- Technology choices
|
|
369
|
+
- Integration patterns
|
|
370
|
+
|
|
371
|
+
### 4. Security Patterns
|
|
372
|
+
- Vulnerabilities and fixes
|
|
373
|
+
- Security best practices
|
|
374
|
+
- Attack patterns
|
|
375
|
+
- Protection measures
|
|
376
|
+
|
|
377
|
+
### 5. Performance Patterns
|
|
378
|
+
- Optimization techniques
|
|
379
|
+
- Bottleneck solutions
|
|
380
|
+
- Caching strategies
|
|
381
|
+
- Resource management
|
|
382
|
+
|
|
383
|
+
### 6. Platform Patterns
|
|
384
|
+
- Platform-specific issues
|
|
385
|
+
- Cross-platform solutions
|
|
386
|
+
- Device-specific problems
|
|
387
|
+
- Browser compatibility
|
|
388
|
+
|
|
389
|
+
---
|
|
390
|
+
|
|
391
|
+
## 🔐 Access Control
|
|
392
|
+
|
|
393
|
+
| Role | Create | Read | Update | Delete |
|
|
394
|
+
|------|--------|------|--------|--------|
|
|
395
|
+
| @DEV | ✅ | ✅ | ✅ | ❌ |
|
|
396
|
+
| @DEVOPS | ✅ | ✅ | ✅ | ❌ |
|
|
397
|
+
| @TESTER | ✅ | ✅ | ✅ | ❌ |
|
|
398
|
+
| @SECA | ✅ | ✅ | ✅ | ❌ |
|
|
399
|
+
| @SA | ✅ | ✅ | ✅ | ❌ |
|
|
400
|
+
| @UIUX | ✅ | ✅ | ✅ | ❌ |
|
|
401
|
+
| @REPORTER | ✅ | ✅ | ✅ | ✅ |
|
|
402
|
+
| @PM | ❌ | ✅ | ❌ | ❌ |
|
|
403
|
+
| @PO | ❌ | ✅ | ❌ | ❌ |
|
|
404
|
+
|
|
405
|
+
---
|
|
406
|
+
|
|
407
|
+
## 📞 Support
|
|
408
|
+
|
|
409
|
+
If you need help with auto-learning:
|
|
410
|
+
- **What to capture:** Tag @REPORTER
|
|
411
|
+
- **How to document:** Use template above
|
|
412
|
+
- **Where to store:** Check category structure
|
|
413
|
+
- **Quality issues:** Tag @REPORTER for review
|
|
414
|
+
|
|
415
|
+
---
|
|
416
|
+
|
|
417
|
+
#auto-learning #knowledge-base #continuous-improvement #project-intelligence
|
|
418
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
## ⚠️ AI AGENT ENFORCEMENT (MANDATORY)
|
|
2
|
+
> **CRITICAL:** AI agents (Gemini, Claude, Cursor, etc.) MUST follow these rules BEFORE starting any task.
|
|
3
|
+
### Pre-Task Requirements
|
|
4
|
+
1. **Read Workflow File First** - When user types /command, READ .agent/workflows/[command].md before any action
|
|
5
|
+
2. **Activate Appropriate Roles** - Check the Role Activation Matrix in GEMINI.md
|
|
6
|
+
3. **Follow State Machine** - Run python tools/brain/brain_cli.py status to check current state
|
|
7
|
+
4. **Search Knowledge Base** - Before implementing, search .agent/knowledge-base/INDEX.md
|
|
8
|
+
5. **Document Learnings** - After task completion, consider KB entry if solution was non-obvious
|
|
9
|
+
### Violation = System Failure
|
|
10
|
+
If an AI agent implements without following workflows, the brain system is NOT being used.
|
|
11
|
+
---
|
|
@@ -1,58 +1,77 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: Artifact and Naming Conventions
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
|
31
|
-
|
|
32
|
-
|
|
|
33
|
-
|
|
|
34
|
-
|
|
|
35
|
-
|
|
|
36
|
-
|
|
|
37
|
-
|
|
|
38
|
-
|
|
|
39
|
-
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
|
47
|
-
|
|
48
|
-
|
|
|
49
|
-
|
|
|
50
|
-
|
|
|
51
|
-
|
|
|
52
|
-
|
|
|
53
|
-
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
1
|
+
---
|
|
2
|
+
description: Artifact and Naming Conventions
|
|
3
|
+
---
|
|
4
|
+
# Artifact & Naming Conventions
|
|
5
|
+
## ⚠️ DOCUMENTATION LOCATION RULE (PROJECT-SPECIFIC)
|
|
6
|
+
Documentation MUST be located within each project's directory, NOT in the root docs/ folder (except for global guides).
|
|
7
|
+
### Correct Structure
|
|
8
|
+
`
|
|
9
|
+
root/
|
|
10
|
+
├── docs/ (Global System Docs ONLY)
|
|
11
|
+
│ ├── ARCHITECTURE.md
|
|
12
|
+
│ └── BRAIN-GUIDE.md
|
|
13
|
+
│
|
|
14
|
+
└── projects/
|
|
15
|
+
└── [project-name]/
|
|
16
|
+
└── docs/ (Project Specific Docs)
|
|
17
|
+
└── sprints/
|
|
18
|
+
└── sprint-[N]/
|
|
19
|
+
├── plans/
|
|
20
|
+
├── requirements/
|
|
21
|
+
├── designs/
|
|
22
|
+
└── logs/
|
|
23
|
+
`
|
|
24
|
+
## Artifact Naming Convention
|
|
25
|
+
Use versioned names attached to the current Sprint:
|
|
26
|
+
| Artifact | Owner |
|
|
27
|
+
|----------|-------|
|
|
28
|
+
| Project-Plan-Sprint-[N]-v*.md | PM |
|
|
29
|
+
| Product-Backlog-Sprint-[N]-v*.md | PO |
|
|
30
|
+
| UIUX-Design-Spec-Sprint-[N]-v*.md | UIUX |
|
|
31
|
+
| System-Design-Spec-Sprint-[N]-v*.md | SA |
|
|
32
|
+
| Design-Verification-Report-Sprint-[N]-v*.md | QA |
|
|
33
|
+
| Security-Review-Report-Sprint-[N]-v*.md | SecA |
|
|
34
|
+
| Development-Log-Sprint-[N]-v*.md | DEV |
|
|
35
|
+
| DevOps-Plan-and-Log-Sprint-[N]-v*.md | DevOps |
|
|
36
|
+
| Test-Report-Sprint-[N]-v*.md | TESTER |
|
|
37
|
+
| Phase-Report-Sprint-[N]-v*.md | REPORTER |
|
|
38
|
+
| Master-Documentation.md | REPORTER |
|
|
39
|
+
| Final-Project-Report.md | REPORTER |
|
|
40
|
+
| Final-Approval-Report.md | STAKEHOLDER |
|
|
41
|
+
## ⚠️ CRITICAL LOCATION RULE (SPRINT FOLDERS)
|
|
42
|
+
ALL project artifacts MUST be created in the **PROJECT'S** workspace with organized structure based on **Sprint**:
|
|
43
|
+
**Base Directory:** projects/[project-name]/docs/sprints/sprint-[N]/
|
|
44
|
+
| Category | Folder Path | Content Example | Owner |
|
|
45
|
+
|----------|-------------|-----------------|-------|
|
|
46
|
+
| Plans | .../plans/ | Project-Plan-Sprint-[N]-v*.md, Product-Backlog-Sprint-[N]-v*.md | PM, PO |
|
|
47
|
+
| Designs | .../designs/ | System-Design-Spec-Sprint-[N]-v*.md, UIUX-Design-Spec-Sprint-[N]-v*.md | SA, UIUX |
|
|
48
|
+
| Reviews | .../reviews/ | Design-Verification-Report-Sprint-[N]-v*.md, Security-Review-Report-Sprint-[N]-v*.md | QA, SecA |
|
|
49
|
+
| Logs | .../logs/ | Development-Log-Sprint-[N]-v*.md, DevOps-Plan-and-Log-Sprint-[N]-v*.md | DEV, DevOps |
|
|
50
|
+
| Tests | .../tests/ | Test-Report-Sprint-[N]-v*.md | TESTER |
|
|
51
|
+
| Reports | .../reports/ | Phase-Report-Sprint-[N]-v*.md | REPORTER |
|
|
52
|
+
| Global | .../global/reports/ | Final-Project-Report.md, Final-Approval-Report.md | REPORTER, STAKEHOLDER |
|
|
53
|
+
| Global | projects/[project-name]/docs/global/ | Master-Documentation.md | REPORTER |
|
|
54
|
+
**FORBIDDEN LOCATIONS:**
|
|
55
|
+
- .agent/ directory (reserved for instructions only)
|
|
56
|
+
- Global docs/ folder for project-specific artifacts.
|
|
57
|
+
## ⚠️ CHANGELOG RULE
|
|
58
|
+
**CRITICAL:** Do NOT create or update CHANGELOG.md in the project root.
|
|
59
|
+
- CHANGELOG.md exists ONLY as a template in .agent/templates/
|
|
60
|
+
- All project changes are documented in sprint-specific reports
|
|
61
|
+
- Use Phase-Report-Sprint-[N]-v*.md for sprint summaries
|
|
62
|
+
- Use Final-Project-Report.md for overall project changelog
|
|
63
|
+
## Mandatory Documentation Tags
|
|
64
|
+
Every action must be tagged with appropriate hashtags:
|
|
65
|
+
| Category | Tags |
|
|
66
|
+
|----------|------|
|
|
67
|
+
| **Planning** | #planning, #product-owner, #backlog |
|
|
68
|
+
| **Design** | #designing, #uiux-design |
|
|
69
|
+
| **Verification** | #verify-design, #security-review |
|
|
70
|
+
| **Development** | #development, #devops |
|
|
71
|
+
| **Testing** | #testing |
|
|
72
|
+
| **Bug Fixes** | #fixbug-critical, #fixbug-high, #fixbug-medium, #fixbug-low |
|
|
73
|
+
| **Status** | #blocked, #hotfix, #rollback |
|
|
74
|
+
| **Deployment** | #deployed-staging, #deployed-production |
|
|
75
|
+
| **Research** | #searching |
|
|
76
|
+
| **Reporting** | #reporting, #stakeholder-review |
|
|
77
|
+
| **Knowledge** | #knowledge-base, #lessons-learned |
|
|
@@ -1,65 +1,25 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: Unified Git and Task Workflow
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
**
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
A feature/task is "Done" when ALL of the following are true:
|
|
27
|
-
|
|
28
|
-
### For Development Tasks:
|
|
29
|
-
- [ ] Code implemented according to approved design specs
|
|
30
|
-
- [ ] Code follows project coding standards
|
|
31
|
-
- [ ] Local testing passed
|
|
32
|
-
- [ ] Evidence captured (screenshots/logs)
|
|
33
|
-
- [ ] Tagged with `#development`
|
|
34
|
-
- [ ] **Git Commit created and linked in Log**
|
|
35
|
-
- [ ] Handoff to TESTER completed
|
|
36
|
-
|
|
37
|
-
### For Testing:
|
|
38
|
-
- [ ] All test cases executed
|
|
39
|
-
- [ ] No critical/high bugs open
|
|
40
|
-
- [ ] Evidence documented in Test-Report
|
|
41
|
-
- [ ] Tagged with `#testing`
|
|
42
|
-
|
|
43
|
-
### For Deployment:
|
|
44
|
-
- [ ] CI/CD pipeline passing
|
|
45
|
-
- [ ] Staging environment verified
|
|
46
|
-
- [ ] Security checklist completed
|
|
47
|
-
- [ ] Tagged with `#deployed-staging` or `#deployed-production`
|
|
48
|
-
|
|
49
|
-
### For Project Completion:
|
|
50
|
-
- [ ] All Must-Have features verified
|
|
51
|
-
- [ ] STAKEHOLDER approved
|
|
52
|
-
- [ ] Final documentation complete
|
|
53
|
-
- [ ] User notified
|
|
54
|
-
|
|
55
|
-
## D. Automated Changelog Updates
|
|
56
|
-
- **Requirement:** Every commit MUST be followed by an update to CHANGELOG.md.
|
|
57
|
-
- **Format:**
|
|
58
|
-
```markdown
|
|
59
|
-
- [YYYY-MM-DD] [Commit-Hash] [Type]: [Description] (@Author)
|
|
60
|
-
```
|
|
61
|
-
- **Types:** Feature, Fix, Refactor, Docs, Chore, Test.
|
|
62
|
-
|
|
63
|
-
## E. Release Summary Generation
|
|
64
|
-
- **Requirement:** After a feature is marked as 'Done' in the board or a 'Release' is triggered, the @REPORTER or @DEV MUST update the CHANGELOG.md with a summary of the version release.
|
|
65
|
-
- **Action:** Consolidate all atomic commits into a cohesive release entry.
|
|
1
|
+
---
|
|
2
|
+
description: Unified Git and Task Workflow (Branching, Committing, Merging)
|
|
3
|
+
---
|
|
4
|
+
# Git & Task Management Workflow
|
|
5
|
+
**Requirement:** All tasks and artifacts must follow the **Branch-Based Workflow**.
|
|
6
|
+
## A. Branching Strategy (MANDATORY)
|
|
7
|
+
❌ **NEVER** commit directly to main or master.
|
|
8
|
+
### Branch Naming Convention
|
|
9
|
+
| Type | Prefix | Use Case |
|
|
10
|
+
|------|--------|----------|
|
|
11
|
+
| **Planning** | plan/ | Project plans, product backlogs |
|
|
12
|
+
| **Design** | design/ | Architecture schematics, UI specs |
|
|
13
|
+
| **Feature** | eat/ | New functionality |
|
|
14
|
+
| **Fix** | ix/ | Bug fixes |
|
|
15
|
+
| **Docs** | docs/ | General documentation |
|
|
16
|
+
**Format:** prefix/TASK-ID-short-name (e.g., plan/SPRINT-2-setup)
|
|
17
|
+
### Workflow
|
|
18
|
+
1. **Start:** git checkout -b prefix/TASK-ID-name from main.
|
|
19
|
+
2. **Work:** Create artifacts or code.
|
|
20
|
+
3. **Push:** git push -u origin prefix/TASK-ID-name.
|
|
21
|
+
4. **Docs-as-Code:** Treat documentation exactly like code.
|
|
22
|
+
## B. Definition of Done (DoD)
|
|
23
|
+
1. Branch created.
|
|
24
|
+
2. Artifacts implemented.
|
|
25
|
+
3. Pull Request created & merged.
|