viepilot 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +230 -0
- package/LICENSE +23 -0
- package/README.md +550 -0
- package/bin/viepilot.cjs +222 -0
- package/bin/vp-tools.cjs +912 -0
- package/dev-install.sh +109 -0
- package/docs/README.md +125 -0
- package/docs/advanced-usage.md +366 -0
- package/docs/api/README.md +12 -0
- package/docs/api/graphql-schema.md +5 -0
- package/docs/api/kafka-events.md +5 -0
- package/docs/api/rest-api.md +19 -0
- package/docs/api/websocket-api.md +5 -0
- package/docs/dev/architecture.md +226 -0
- package/docs/dev/cli-reference.md +324 -0
- package/docs/dev/contributing.md +195 -0
- package/docs/dev/deployment.md +204 -0
- package/docs/dev/getting-started.md +16 -0
- package/docs/dev/testing.md +171 -0
- package/docs/dev/ui-components-library.md +36 -0
- package/docs/getting-started.md +163 -0
- package/docs/skills-reference.md +399 -0
- package/docs/troubleshooting.md +297 -0
- package/docs/user/faq.md +117 -0
- package/docs/user/features/autonomous-mode.md +111 -0
- package/docs/user/features/checkpoint-recovery.md +76 -0
- package/docs/user/features/debug-mode.md +77 -0
- package/docs/user/features/ui-direction.md +29 -0
- package/docs/user/quick-start.md +157 -0
- package/docs/videos/01-installation.md +113 -0
- package/docs/videos/02-first-project.md +132 -0
- package/docs/videos/03-autonomous-mode.md +147 -0
- package/install.sh +144 -0
- package/lib/cli-shared.cjs +108 -0
- package/package.json +78 -0
- package/skills/vp-audit/SKILL.md +140 -0
- package/skills/vp-auto/SKILL.md +204 -0
- package/skills/vp-brainstorm/SKILL.md +75 -0
- package/skills/vp-crystallize/SKILL.md +175 -0
- package/skills/vp-debug/SKILL.md +96 -0
- package/skills/vp-docs/SKILL.md +258 -0
- package/skills/vp-evolve/SKILL.md +165 -0
- package/skills/vp-pause/SKILL.md +150 -0
- package/skills/vp-request/SKILL.md +250 -0
- package/skills/vp-resume/SKILL.md +141 -0
- package/skills/vp-rollback/SKILL.md +116 -0
- package/skills/vp-status/SKILL.md +137 -0
- package/skills/vp-task/SKILL.md +139 -0
- package/skills/vp-ui-components/SKILL.md +64 -0
- package/templates/phase/PHASE-STATE.md +35 -0
- package/templates/phase/SPEC.md +40 -0
- package/templates/phase/SUMMARY.md +67 -0
- package/templates/phase/TASK.md +101 -0
- package/templates/phase/VERIFICATION.md +49 -0
- package/templates/project/AI-GUIDE.md +114 -0
- package/templates/project/ARCHITECTURE.md +70 -0
- package/templates/project/CHANGELOG.md +36 -0
- package/templates/project/CONTRIBUTING.md +154 -0
- package/templates/project/CONTRIBUTORS.md +41 -0
- package/templates/project/PROJECT-CONTEXT.md +74 -0
- package/templates/project/PROJECT-META.md +133 -0
- package/templates/project/README.md +197 -0
- package/templates/project/ROADMAP.md +56 -0
- package/templates/project/SYSTEM-RULES.md +368 -0
- package/templates/project/TRACKER.md +50 -0
- package/ui-components/INDEX.md +9 -0
- package/ui-components/base/button/README.md +8 -0
- package/ui-components/base/button/metadata.json +8 -0
- package/ui-components/base/card/README.md +8 -0
- package/ui-components/base/card/metadata.json +8 -0
- package/ui-components/base/input/README.md +8 -0
- package/ui-components/base/input/metadata.json +8 -0
- package/workflows/audit.md +549 -0
- package/workflows/autonomous.md +425 -0
- package/workflows/brainstorm.md +257 -0
- package/workflows/crystallize.md +418 -0
- package/workflows/debug.md +241 -0
- package/workflows/documentation.md +587 -0
- package/workflows/evolve.md +258 -0
- package/workflows/pause-work.md +255 -0
- package/workflows/request.md +534 -0
- package/workflows/resume-work.md +226 -0
- package/workflows/rollback.md +202 -0
- package/workflows/ui-components.md +109 -0
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
# {{PROJECT_NAME}}
|
|
2
|
+
|
|
3
|
+
**{{PROJECT_DESCRIPTION}}**
|
|
4
|
+
|
|
5
|
+
[](CHANGELOG.md)
|
|
6
|
+
[](LICENSE)
|
|
7
|
+
[](https://github.com/0-CODE/viepilot)
|
|
8
|
+
|
|
9
|
+
{{PROJECT_DESCRIPTION_LONG}}
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Quy mรด dแปฑ รกn / Project Scale
|
|
14
|
+
|
|
15
|
+
| Chแป sแป / Metric | Giรก trแป / Value |
|
|
16
|
+
|-----------------|-----------------|
|
|
17
|
+
| Version | {{VERSION}} |
|
|
18
|
+
| Phases | {{PHASE_COUNT}} |
|
|
19
|
+
| Status | {{STATUS}} |
|
|
20
|
+
| Started | {{INCEPTION_YEAR}} |
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Tรญnh nฤng / Features
|
|
25
|
+
|
|
26
|
+
{{FEATURES_LIST}}
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## Tech Stack
|
|
31
|
+
|
|
32
|
+
| Layer | Technology |
|
|
33
|
+
|-------|------------|
|
|
34
|
+
{{TECH_STACK_TABLE}}
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Bแบฏt ฤแบงu nhanh / Quick Start
|
|
39
|
+
|
|
40
|
+
### Prerequisites / Yรชu cแบงu
|
|
41
|
+
|
|
42
|
+
{{PREREQUISITES}}
|
|
43
|
+
|
|
44
|
+
### Installation / Cร i ฤแบทt
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
# Clone repository
|
|
48
|
+
git clone {{REPOSITORY_URL}}
|
|
49
|
+
cd {{ARTIFACT_ID}}
|
|
50
|
+
|
|
51
|
+
# Install dependencies
|
|
52
|
+
{{INSTALL_COMMAND}}
|
|
53
|
+
|
|
54
|
+
# Setup environment
|
|
55
|
+
cp .env.example .env
|
|
56
|
+
|
|
57
|
+
# Run
|
|
58
|
+
{{RUN_COMMAND}}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Using Makefile (if available)
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
make setup # Setup environment
|
|
65
|
+
make dev # Start development
|
|
66
|
+
make test # Run tests
|
|
67
|
+
make build # Build for production
|
|
68
|
+
make help # Show all commands
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## Cแบฅu trรบc dแปฑ รกn / Project Structure
|
|
74
|
+
|
|
75
|
+
```
|
|
76
|
+
{{ARTIFACT_ID}}/
|
|
77
|
+
โโโ {{PROJECT_STRUCTURE}}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## Development / Phรกt triแปn
|
|
83
|
+
|
|
84
|
+
### Development Workflow
|
|
85
|
+
|
|
86
|
+
Dแปฑ รกn nร y ฤฦฐแปฃc phรกt triแปn vแปi [ViePilot](https://github.com/0-CODE/viepilot) framework.
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
# Xem tiแบฟn ฤแป / Check progress
|
|
90
|
+
/vp-status
|
|
91
|
+
|
|
92
|
+
# Tiแบฟp tแปฅc phรกt triแปn / Continue development
|
|
93
|
+
/vp-auto
|
|
94
|
+
|
|
95
|
+
# Thรชm feature mแปi / Add new feature
|
|
96
|
+
/vp-request --feature
|
|
97
|
+
|
|
98
|
+
# Report bug
|
|
99
|
+
/vp-request --bug
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### Current Progress
|
|
103
|
+
|
|
104
|
+
```
|
|
105
|
+
{{PROGRESS_BAR}}
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Xem chi tiแบฟt tแบกi / See details at: [.viepilot/TRACKER.md](.viepilot/TRACKER.md)
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## API Documentation / Tร i liแปu API
|
|
113
|
+
|
|
114
|
+
{{API_DOCS_SECTION}}
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
## Testing / Kiแปm thแปญ
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
# Run all tests
|
|
122
|
+
{{TEST_COMMAND}}
|
|
123
|
+
|
|
124
|
+
# Run specific tests
|
|
125
|
+
{{TEST_SPECIFIC_COMMAND}}
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## Deployment / Triแปn khai
|
|
131
|
+
|
|
132
|
+
{{DEPLOYMENT_SECTION}}
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
## Tร i liแปu / Documentation
|
|
137
|
+
|
|
138
|
+
| Tร i liแปu / Document | Nแปi dung / Content |
|
|
139
|
+
|---------------------|-------------------|
|
|
140
|
+
| [Architecture](.viepilot/ARCHITECTURE.md) | Kiแบฟn trรบc hแป thแปng / System architecture |
|
|
141
|
+
| [API Reference](docs/api/) | Tร i liแปu API / API documentation |
|
|
142
|
+
| [Developer Guide](docs/dev/) | Hฦฐแปng dแบซn phรกt triแปn / Developer guide |
|
|
143
|
+
| [CHANGELOG](CHANGELOG.md) | Lแปch sแปญ thay ฤแปi / Version history |
|
|
144
|
+
| [CONTRIBUTING](CONTRIBUTING.md) | Hฦฐแปng dแบซn ฤรณng gรณp / How to contribute |
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Roadmap
|
|
149
|
+
|
|
150
|
+
{{ROADMAP_SUMMARY}}
|
|
151
|
+
|
|
152
|
+
Xem chi tiแบฟt tแบกi / See details at: [.viepilot/ROADMAP.md](.viepilot/ROADMAP.md)
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
## ฤรณng gรณp / Contributing
|
|
157
|
+
|
|
158
|
+
Chรบng tรดi hoan nghรชnh mแปi ฤรณng gรณp! / We welcome contributions!
|
|
159
|
+
|
|
160
|
+
Xem [CONTRIBUTING.md](CONTRIBUTING.md) ฤแป biแบฟt chi tiแบฟt.
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
## Team / ฤแปi ngลฉ
|
|
165
|
+
|
|
166
|
+
### Maintainers
|
|
167
|
+
|
|
168
|
+
| Name | Role | Contact |
|
|
169
|
+
|------|------|---------|
|
|
170
|
+
| {{LEAD_DEVELOPER_NAME}} | Project Lead | [@{{LEAD_DEVELOPER_GITHUB}}](https://github.com/{{LEAD_DEVELOPER_GITHUB}}) |
|
|
171
|
+
|
|
172
|
+
### Contributors
|
|
173
|
+
|
|
174
|
+
Xem danh sรกch ฤแบงy ฤแปง tแบกi / See full list at: [CONTRIBUTORS.md](CONTRIBUTORS.md)
|
|
175
|
+
|
|
176
|
+
---
|
|
177
|
+
|
|
178
|
+
## License / Giแบฅy phรฉp
|
|
179
|
+
|
|
180
|
+
{{LICENSE}} License - Xem [LICENSE](LICENSE) ฤแป biแบฟt chi tiแบฟt.
|
|
181
|
+
|
|
182
|
+
---
|
|
183
|
+
|
|
184
|
+
## Acknowledgments / Ghi nhแบญn
|
|
185
|
+
|
|
186
|
+
- Built with [ViePilot](https://github.com/0-CODE/viepilot) - Autonomous Vibe Coding Framework
|
|
187
|
+
{{ACKNOWLEDGMENTS}}
|
|
188
|
+
|
|
189
|
+
---
|
|
190
|
+
|
|
191
|
+
<p align="center">
|
|
192
|
+
<strong>{{PROJECT_NAME}}</strong>
|
|
193
|
+
<br>
|
|
194
|
+
{{TAGLINE}}
|
|
195
|
+
<br><br>
|
|
196
|
+
Copyright ยฉ {{INCEPTION_YEAR}} {{ORGANIZATION_NAME}}
|
|
197
|
+
</p>
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} - Roadmap
|
|
2
|
+
|
|
3
|
+
## Milestone: {{MILESTONE_NAME}}
|
|
4
|
+
|
|
5
|
+
### Overview
|
|
6
|
+
- **Version**: {{VERSION}}
|
|
7
|
+
- **Goal**: {{MILESTONE_GOAL}}
|
|
8
|
+
- **Phases**: {{PHASE_COUNT}}
|
|
9
|
+
- **Status**: Not Started
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
### Phase 1: {{PHASE_1_NAME}}
|
|
14
|
+
**Goal**: {{PHASE_1_GOAL}}
|
|
15
|
+
**Estimated Tasks**: {{PHASE_1_TASK_COUNT}}
|
|
16
|
+
**Dependencies**: None
|
|
17
|
+
|
|
18
|
+
| Task | Description | Acceptance Criteria | Complexity |
|
|
19
|
+
|------|-------------|---------------------|------------|
|
|
20
|
+
| 1.1 | {{TASK_1_1}} | {{CRITERIA_1_1}} | S |
|
|
21
|
+
| 1.2 | {{TASK_1_2}} | {{CRITERIA_1_2}} | M |
|
|
22
|
+
|
|
23
|
+
**Verification**:
|
|
24
|
+
- [ ] {{VERIFICATION_1}}
|
|
25
|
+
- [ ] {{VERIFICATION_2}}
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
### Phase 2: {{PHASE_2_NAME}}
|
|
30
|
+
**Goal**: {{PHASE_2_GOAL}}
|
|
31
|
+
**Estimated Tasks**: {{PHASE_2_TASK_COUNT}}
|
|
32
|
+
**Dependencies**: Phase 1
|
|
33
|
+
|
|
34
|
+
| Task | Description | Acceptance Criteria | Complexity |
|
|
35
|
+
|------|-------------|---------------------|------------|
|
|
36
|
+
| 2.1 | {{TASK_2_1}} | {{CRITERIA_2_1}} | M |
|
|
37
|
+
| 2.2 | {{TASK_2_2}} | {{CRITERIA_2_2}} | L |
|
|
38
|
+
|
|
39
|
+
**Verification**:
|
|
40
|
+
- [ ] {{VERIFICATION_1}}
|
|
41
|
+
- [ ] {{VERIFICATION_2}}
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## Progress Summary
|
|
46
|
+
|
|
47
|
+
| Phase | Status | Tasks | Completed | Progress |
|
|
48
|
+
|-------|--------|-------|-----------|----------|
|
|
49
|
+
| 1. {{PHASE_1_NAME}} | Not Started | {{COUNT}} | 0 | 0% |
|
|
50
|
+
| 2. {{PHASE_2_NAME}} | Not Started | {{COUNT}} | 0 | 0% |
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Notes
|
|
55
|
+
- Created: {{DATE}}
|
|
56
|
+
- Last Updated: {{DATE}}
|
|
@@ -0,0 +1,368 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} - System Rules
|
|
2
|
+
|
|
3
|
+
## Table of Contents
|
|
4
|
+
1. [Architecture Rules](#architecture_rules)
|
|
5
|
+
2. [Coding Rules](#coding_rules)
|
|
6
|
+
3. [Comment Standards](#comment_standards)
|
|
7
|
+
4. [Versioning](#versioning)
|
|
8
|
+
5. [Git Conventions](#git_conventions)
|
|
9
|
+
6. [Changelog Standards](#changelog_standards)
|
|
10
|
+
7. [Contributor Standards](#contributor_standards)
|
|
11
|
+
8. [Quality Gates](#quality_gates)
|
|
12
|
+
9. [Forbidden Patterns](#do_not)
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
<architecture_rules>
|
|
17
|
+
## Architecture Rules
|
|
18
|
+
|
|
19
|
+
### Layer Structure
|
|
20
|
+
```
|
|
21
|
+
src/main/java/{{PACKAGE_PATH}}/
|
|
22
|
+
โโโ controller/ # REST/GraphQL endpoints
|
|
23
|
+
โโโ service/ # Business logic
|
|
24
|
+
โโโ mapper/ # Data access (MyBatis/JPA)
|
|
25
|
+
โโโ model/ # Entities, DTOs
|
|
26
|
+
โโโ config/ # Spring configs
|
|
27
|
+
โโโ util/ # Helpers
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Dependency Rules
|
|
31
|
+
- Controller โ Service (never reverse)
|
|
32
|
+
- Service โ Mapper/Repository (never reverse)
|
|
33
|
+
- No circular dependencies between modules
|
|
34
|
+
|
|
35
|
+
### Service Boundaries
|
|
36
|
+
{{SERVICE_BOUNDARIES}}
|
|
37
|
+
</architecture_rules>
|
|
38
|
+
|
|
39
|
+
<coding_rules>
|
|
40
|
+
## Coding Rules
|
|
41
|
+
|
|
42
|
+
### General
|
|
43
|
+
- Follow project naming conventions
|
|
44
|
+
- Use meaningful variable/method names
|
|
45
|
+
- Keep methods small (< 30 lines preferred)
|
|
46
|
+
- Single responsibility principle
|
|
47
|
+
|
|
48
|
+
### Language Specific
|
|
49
|
+
{{LANGUAGE_SPECIFIC_RULES}}
|
|
50
|
+
|
|
51
|
+
### Testing
|
|
52
|
+
- Unit tests for all service methods
|
|
53
|
+
- Integration tests for API endpoints
|
|
54
|
+
- Test naming: `should_expectedBehavior_when_condition()`
|
|
55
|
+
- Minimum coverage: {{COVERAGE_THRESHOLD}}%
|
|
56
|
+
</coding_rules>
|
|
57
|
+
|
|
58
|
+
<comment_standards>
|
|
59
|
+
## Comment Standards
|
|
60
|
+
|
|
61
|
+
### Philosophy
|
|
62
|
+
> "Code tells you HOW, comments tell you WHY"
|
|
63
|
+
|
|
64
|
+
### Good Comments โ
|
|
65
|
+
|
|
66
|
+
#### 1. Explain WHY (Intent/Rationale)
|
|
67
|
+
```java
|
|
68
|
+
// โ
GOOD: Explains why this specific value
|
|
69
|
+
// Use 5-second timeout because external API may have latency spikes.
|
|
70
|
+
// Tested with production data showing 3-4s avg response.
|
|
71
|
+
private static final int API_TIMEOUT_MS = 5000;
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
#### 2. Explain Business Rules
|
|
75
|
+
```java
|
|
76
|
+
// โ
GOOD: Documents business rule
|
|
77
|
+
// Orders over $1000 require manager approval per company policy.
|
|
78
|
+
// See POLICY-2024-03 for details.
|
|
79
|
+
if (order.getTotal() > 1000) {
|
|
80
|
+
requireManagerApproval(order);
|
|
81
|
+
}
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
#### 3. Warn About Non-Obvious Behavior
|
|
85
|
+
```java
|
|
86
|
+
// โ
GOOD: Warning about side effect
|
|
87
|
+
// WARNING: This method also updates the cache.
|
|
88
|
+
// Do not call in read-only contexts.
|
|
89
|
+
public Data fetchData(String id) {
|
|
90
|
+
updateCache(id); // Side effect
|
|
91
|
+
return repository.findById(id);
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
#### 4. Document Workarounds/Hacks
|
|
96
|
+
```java
|
|
97
|
+
// โ
GOOD: Explains temporary workaround
|
|
98
|
+
// HACK: Library X has bug with null values.
|
|
99
|
+
// Using empty string as workaround until v2.0 release.
|
|
100
|
+
// Tracking issue: https://github.com/lib/x/issues/123
|
|
101
|
+
// TODO: Remove after upgrading to v2.0
|
|
102
|
+
private String sanitize(String input) {
|
|
103
|
+
return input == null ? "" : input;
|
|
104
|
+
}
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
#### 5. Explain Complex Algorithms
|
|
108
|
+
```java
|
|
109
|
+
// โ
GOOD: Explains the algorithm
|
|
110
|
+
/**
|
|
111
|
+
* Calculates discount using tiered pricing:
|
|
112
|
+
* - 0-100 units: no discount
|
|
113
|
+
* - 101-500 units: 10% discount
|
|
114
|
+
* - 500+ units: 20% discount
|
|
115
|
+
*
|
|
116
|
+
* @see PricingPolicy for tier definitions
|
|
117
|
+
*/
|
|
118
|
+
public BigDecimal calculateDiscount(int quantity) {
|
|
119
|
+
// Implementation
|
|
120
|
+
}
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Bad Comments โ
|
|
124
|
+
|
|
125
|
+
#### 1. Stating the Obvious
|
|
126
|
+
```java
|
|
127
|
+
// โ BAD: Obvious from code
|
|
128
|
+
// Increment counter
|
|
129
|
+
counter++;
|
|
130
|
+
|
|
131
|
+
// Get the user
|
|
132
|
+
User user = userRepository.findById(id);
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
#### 2. Commented-Out Code
|
|
136
|
+
```java
|
|
137
|
+
// โ BAD: Delete dead code, use git history
|
|
138
|
+
public void process() {
|
|
139
|
+
// oldMethod();
|
|
140
|
+
// if (flag) { doSomething(); }
|
|
141
|
+
newMethod();
|
|
142
|
+
}
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
#### 3. Journal/Changelog Comments
|
|
146
|
+
```java
|
|
147
|
+
// โ BAD: Use git history
|
|
148
|
+
/**
|
|
149
|
+
* Change history:
|
|
150
|
+
* 2024-01-01: Created by John
|
|
151
|
+
* 2024-01-15: Fixed bug - Jane
|
|
152
|
+
*/
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
#### 4. Noise Comments
|
|
156
|
+
```java
|
|
157
|
+
// โ BAD: Adds no value
|
|
158
|
+
/**
|
|
159
|
+
* Default constructor.
|
|
160
|
+
*/
|
|
161
|
+
public MyClass() {}
|
|
162
|
+
|
|
163
|
+
/**
|
|
164
|
+
* Gets the id.
|
|
165
|
+
* @return the id
|
|
166
|
+
*/
|
|
167
|
+
public Long getId() { return id; }
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
#### 5. Misleading Comments
|
|
171
|
+
```java
|
|
172
|
+
// โ BAD: Comment lies about what method does
|
|
173
|
+
// Returns the user (but actually modifies database!)
|
|
174
|
+
public User getUser(Long id) {
|
|
175
|
+
User user = repository.find(id);
|
|
176
|
+
user.setLastAccess(now()); // Not mentioned in comment!
|
|
177
|
+
repository.save(user);
|
|
178
|
+
return user;
|
|
179
|
+
}
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
### TODO/FIXME Format
|
|
183
|
+
```java
|
|
184
|
+
// TODO(username): Brief description - TICKET-123
|
|
185
|
+
// FIXME: Description of bug - TICKET-456
|
|
186
|
+
// HACK: Temporary workaround - remove after TICKET-789
|
|
187
|
+
// WARNING: Important caution
|
|
188
|
+
// NOTE: Important context
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
### Comment Language
|
|
192
|
+
- Code comments: English
|
|
193
|
+
- Commit messages: English
|
|
194
|
+
</comment_standards>
|
|
195
|
+
|
|
196
|
+
<versioning>
|
|
197
|
+
## Semantic Versioning
|
|
198
|
+
|
|
199
|
+
Format: `MAJOR.MINOR.PATCH[-PRERELEASE]`
|
|
200
|
+
|
|
201
|
+
| Bump | When | Example |
|
|
202
|
+
|------|------|---------|
|
|
203
|
+
| MAJOR | Breaking changes | 1.x.x โ 2.0.0 |
|
|
204
|
+
| MINOR | New features (backward compatible) | 1.1.x โ 1.2.0 |
|
|
205
|
+
| PATCH | Bug fixes (backward compatible) | 1.1.1 โ 1.1.2 |
|
|
206
|
+
|
|
207
|
+
### Pre-release Labels
|
|
208
|
+
- `alpha` : Feature incomplete
|
|
209
|
+
- `beta` : Feature complete, may have bugs
|
|
210
|
+
- `rc` : Release candidate
|
|
211
|
+
|
|
212
|
+
### Version Bump Triggers
|
|
213
|
+
```yaml
|
|
214
|
+
patch:
|
|
215
|
+
- Bug fix
|
|
216
|
+
- Documentation update
|
|
217
|
+
- Dependency patch
|
|
218
|
+
|
|
219
|
+
minor:
|
|
220
|
+
- New feature
|
|
221
|
+
- New API endpoint
|
|
222
|
+
- Deprecation (not removal)
|
|
223
|
+
|
|
224
|
+
major:
|
|
225
|
+
- Breaking API change
|
|
226
|
+
- Removed feature
|
|
227
|
+
- Breaking schema change
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
Reference: https://semver.org/
|
|
231
|
+
</versioning>
|
|
232
|
+
|
|
233
|
+
<git_conventions>
|
|
234
|
+
## Git Conventions
|
|
235
|
+
|
|
236
|
+
### Commit Message Format
|
|
237
|
+
```
|
|
238
|
+
<type>(<scope>): <subject>
|
|
239
|
+
|
|
240
|
+
[optional body]
|
|
241
|
+
|
|
242
|
+
[optional footer]
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
### Types
|
|
246
|
+
| Type | Description | Version |
|
|
247
|
+
|------|-------------|---------|
|
|
248
|
+
| `feat` | New feature | MINOR |
|
|
249
|
+
| `fix` | Bug fix | PATCH |
|
|
250
|
+
| `docs` | Documentation | - |
|
|
251
|
+
| `style` | Formatting | - |
|
|
252
|
+
| `refactor` | Code change, no feature/fix | - |
|
|
253
|
+
| `perf` | Performance | PATCH |
|
|
254
|
+
| `test` | Tests | - |
|
|
255
|
+
| `build` | Build system | - |
|
|
256
|
+
| `ci` | CI config | - |
|
|
257
|
+
| `chore` | Maintenance | - |
|
|
258
|
+
|
|
259
|
+
### Scopes
|
|
260
|
+
{{GIT_SCOPES}}
|
|
261
|
+
|
|
262
|
+
### Breaking Changes
|
|
263
|
+
```
|
|
264
|
+
feat(api)!: change endpoint response format
|
|
265
|
+
|
|
266
|
+
BREAKING CHANGE: Response now includes nested object
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
### Examples
|
|
270
|
+
```bash
|
|
271
|
+
feat(user): add email verification
|
|
272
|
+
fix(auth): resolve token expiration issue
|
|
273
|
+
docs(readme): update installation steps
|
|
274
|
+
refactor(service): extract validation logic
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
Reference: https://www.conventionalcommits.org/
|
|
278
|
+
</git_conventions>
|
|
279
|
+
|
|
280
|
+
<changelog_standards>
|
|
281
|
+
## Changelog Standards
|
|
282
|
+
|
|
283
|
+
Format: [Keep a Changelog](https://keepachangelog.com/)
|
|
284
|
+
|
|
285
|
+
### Categories (in order)
|
|
286
|
+
1. **Added** - New features
|
|
287
|
+
2. **Changed** - Changes in existing functionality
|
|
288
|
+
3. **Deprecated** - Soon-to-be removed features
|
|
289
|
+
4. **Removed** - Removed features
|
|
290
|
+
5. **Fixed** - Bug fixes
|
|
291
|
+
6. **Security** - Vulnerability fixes
|
|
292
|
+
|
|
293
|
+
### Entry Format
|
|
294
|
+
```markdown
|
|
295
|
+
- Brief description ([#123](link))
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
### Auto-update Mapping
|
|
299
|
+
```yaml
|
|
300
|
+
feat โ Added
|
|
301
|
+
fix โ Fixed
|
|
302
|
+
BREAKING CHANGE โ Changed
|
|
303
|
+
deprecate โ Deprecated
|
|
304
|
+
remove โ Removed
|
|
305
|
+
security โ Security
|
|
306
|
+
```
|
|
307
|
+
</changelog_standards>
|
|
308
|
+
|
|
309
|
+
<contributor_standards>
|
|
310
|
+
## Contributor Standards
|
|
311
|
+
|
|
312
|
+
### Attribution
|
|
313
|
+
- All contributors in CONTRIBUTORS.md
|
|
314
|
+
- Commit co-authors for pair programming
|
|
315
|
+
- Release notes credit
|
|
316
|
+
|
|
317
|
+
### Contribution Types
|
|
318
|
+
| Emoji | Type |
|
|
319
|
+
|-------|------|
|
|
320
|
+
| ๐ป | Code |
|
|
321
|
+
| ๐ | Documentation |
|
|
322
|
+
| ๐ | Bug Reports |
|
|
323
|
+
| ๐ก | Ideas |
|
|
324
|
+
| ๐ | Review |
|
|
325
|
+
| ๐งช | Testing |
|
|
326
|
+
</contributor_standards>
|
|
327
|
+
|
|
328
|
+
<quality_gates>
|
|
329
|
+
## Quality Gates
|
|
330
|
+
|
|
331
|
+
### Task Completion
|
|
332
|
+
- [ ] All acceptance criteria met
|
|
333
|
+
- [ ] Automated tests pass
|
|
334
|
+
- [ ] No lint errors
|
|
335
|
+
- [ ] Code review (for L/XL tasks)
|
|
336
|
+
|
|
337
|
+
### Phase Completion
|
|
338
|
+
- [ ] All tasks done or skipped (with reason)
|
|
339
|
+
- [ ] Phase verification pass
|
|
340
|
+
- [ ] No active blockers
|
|
341
|
+
- [ ] Documentation updated
|
|
342
|
+
|
|
343
|
+
### Milestone Completion
|
|
344
|
+
- [ ] All phases complete
|
|
345
|
+
- [ ] E2E tests pass
|
|
346
|
+
- [ ] Security scan clean
|
|
347
|
+
- [ ] Documentation complete
|
|
348
|
+
</quality_gates>
|
|
349
|
+
|
|
350
|
+
<do_not>
|
|
351
|
+
## Forbidden Patterns
|
|
352
|
+
|
|
353
|
+
### Code
|
|
354
|
+
- โ Do NOT hardcode credentials
|
|
355
|
+
- โ Do NOT catch generic Exception
|
|
356
|
+
- โ Do NOT use Thread.sleep() in production
|
|
357
|
+
- โ Do NOT ignore compiler warnings
|
|
358
|
+
- โ Do NOT commit commented-out code
|
|
359
|
+
|
|
360
|
+
### Architecture
|
|
361
|
+
{{FORBIDDEN_ARCHITECTURE_PATTERNS}}
|
|
362
|
+
|
|
363
|
+
### Security
|
|
364
|
+
- โ Do NOT log sensitive data
|
|
365
|
+
- โ Do NOT store plain-text passwords
|
|
366
|
+
- โ Do NOT expose internal IDs in APIs
|
|
367
|
+
- โ Do NOT trust user input without validation
|
|
368
|
+
</do_not>
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} - Tracker
|
|
2
|
+
|
|
3
|
+
## Current State
|
|
4
|
+
- **Milestone**: {{MILESTONE_NAME}}
|
|
5
|
+
- **Current Phase**: {{CURRENT_PHASE}}
|
|
6
|
+
- **Current Task**: {{CURRENT_TASK}}
|
|
7
|
+
- **Last Activity**: {{LAST_ACTIVITY}}
|
|
8
|
+
|
|
9
|
+
## Progress Overview
|
|
10
|
+
```
|
|
11
|
+
Phase 1: {{PHASE_1_NAME}} [โโโโโโโโโโ] 0%
|
|
12
|
+
Phase 2: {{PHASE_2_NAME}} [โโโโโโโโโโ] 0%
|
|
13
|
+
Phase 3: {{PHASE_3_NAME}} [โโโโโโโโโโ] 0%
|
|
14
|
+
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
|
|
15
|
+
Overall: [โโโโโโโโโโ] 0%
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Version Info
|
|
19
|
+
|
|
20
|
+
### Current Version
|
|
21
|
+
```
|
|
22
|
+
{{VERSION}}
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### Version History
|
|
26
|
+
| Version | Date | Milestone | Notes |
|
|
27
|
+
|---------|------|-----------|-------|
|
|
28
|
+
| {{VERSION}} | {{DATE}} | {{MILESTONE_NAME}} | Initial setup |
|
|
29
|
+
|
|
30
|
+
### Next Version
|
|
31
|
+
```
|
|
32
|
+
Pending changes in [Unreleased]:
|
|
33
|
+
- 0 features
|
|
34
|
+
- 0 fixes
|
|
35
|
+
- 0 breaking changes
|
|
36
|
+
|
|
37
|
+
Suggested next version: {{VERSION}}
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Decision Log
|
|
41
|
+
|
|
42
|
+
| Date | Decision | Rationale | Phase |
|
|
43
|
+
|------|----------|-----------|-------|
|
|
44
|
+
| {{DATE}} | Initial architecture | From brainstorm | Setup |
|
|
45
|
+
|
|
46
|
+
## Blockers
|
|
47
|
+
_None currently_
|
|
48
|
+
|
|
49
|
+
## Next Action
|
|
50
|
+
**Start Phase 1**: Run `/vp-auto` to begin autonomous execution
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# UI Components Stock Index
|
|
2
|
+
|
|
3
|
+
Baseline components shipped with ViePilot installation.
|
|
4
|
+
|
|
5
|
+
| ID | Category | Status | Path |
|
|
6
|
+
|----|----------|--------|------|
|
|
7
|
+
| `base-button-primary` | base | approved | `ui-components/base/button/` |
|
|
8
|
+
| `base-card-elevated` | base | approved | `ui-components/base/card/` |
|
|
9
|
+
| `base-input-text` | base | approved | `ui-components/base/input/` |
|