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,114 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} - AI Navigation Guide
|
|
2
|
+
|
|
3
|
+
> **Đọc file này TRƯỚC KHI làm bất kỳ task nào**
|
|
4
|
+
> File này giúp bạn tìm đúng context mà không cần load tất cả
|
|
5
|
+
|
|
6
|
+
## Quick Lookup
|
|
7
|
+
|
|
8
|
+
| Tôi cần... | Đọc file | Section |
|
|
9
|
+
|------------|----------|---------|
|
|
10
|
+
| Hiểu project làm gì | `PROJECT-CONTEXT.md` | `<domain_knowledge>` |
|
|
11
|
+
| Biết tech stack | `ARCHITECTURE.md` | `## Technology Decisions` |
|
|
12
|
+
| Xem service nào làm gì | `ARCHITECTURE.md` | `## Services` |
|
|
13
|
+
| Biết đang ở phase nào | `TRACKER.md` | `## Current State` |
|
|
14
|
+
| Xem task tiếp theo | `ROADMAP.md` | Tìm phase đang `In Progress` |
|
|
15
|
+
| Coding conventions | `SYSTEM-RULES.md` | `<coding_rules>` |
|
|
16
|
+
| Những gì KHÔNG được làm | `SYSTEM-RULES.md` | `<do_not>` |
|
|
17
|
+
| Database schema | `schemas/database-schema.sql` | - |
|
|
18
|
+
| API contracts | `schemas/api-contracts.yaml` | - |
|
|
19
|
+
| Decisions đã quyết định | `TRACKER.md` | `## Decision Log` |
|
|
20
|
+
| Resume công việc dở | `HANDOFF.json` | - |
|
|
21
|
+
| Package structure | `PROJECT-META.md` | `## Package Structure` |
|
|
22
|
+
| File headers | `PROJECT-META.md` | `## File Headers` |
|
|
23
|
+
|
|
24
|
+
## Context Loading Strategy
|
|
25
|
+
|
|
26
|
+
### Minimal Context (cho quick tasks)
|
|
27
|
+
```
|
|
28
|
+
Chỉ đọc:
|
|
29
|
+
1. AI-GUIDE.md (file này)
|
|
30
|
+
2. TRACKER.md → Current State
|
|
31
|
+
3. File cụ thể liên quan đến task
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Standard Context (cho coding tasks)
|
|
35
|
+
```
|
|
36
|
+
Đọc theo thứ tự:
|
|
37
|
+
1. AI-GUIDE.md (file này)
|
|
38
|
+
2. TRACKER.md → biết đang ở đâu
|
|
39
|
+
3. ROADMAP.md → task hiện tại
|
|
40
|
+
4. SYSTEM-RULES.md → coding rules
|
|
41
|
+
5. Schema file nếu cần
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Full Context (cho architecture decisions)
|
|
45
|
+
```
|
|
46
|
+
Đọc thêm:
|
|
47
|
+
1. Standard Context +
|
|
48
|
+
2. ARCHITECTURE.md
|
|
49
|
+
3. PROJECT-CONTEXT.md
|
|
50
|
+
4. Brainstorm session gốc (nếu cần rationale)
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## File Relationships
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
AI-GUIDE.md (đọc đầu tiên)
|
|
57
|
+
│
|
|
58
|
+
├── TRACKER.md (state hiện tại)
|
|
59
|
+
│ └── points to → current phase in ROADMAP.md
|
|
60
|
+
│
|
|
61
|
+
├── ROADMAP.md (what to do)
|
|
62
|
+
│ └── tasks reference → schemas/
|
|
63
|
+
│
|
|
64
|
+
├── SYSTEM-RULES.md (how to code)
|
|
65
|
+
│ └── rules reference → ARCHITECTURE.md
|
|
66
|
+
│
|
|
67
|
+
├── ARCHITECTURE.md (system design)
|
|
68
|
+
│ └── decisions from → PROJECT-CONTEXT.md
|
|
69
|
+
│
|
|
70
|
+
└── PROJECT-CONTEXT.md (domain knowledge)
|
|
71
|
+
└── extracted from → docs/brainstorm/
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## When Creating New Files
|
|
75
|
+
|
|
76
|
+
1. Read `PROJECT-META.md#file-headers` for correct header
|
|
77
|
+
2. Use package from `PROJECT-META.md#package-structure`
|
|
78
|
+
3. Add @author tag from `PROJECT-META.md#lead-developer`
|
|
79
|
+
4. Follow `SYSTEM-RULES.md#coding_rules`
|
|
80
|
+
5. Follow `SYSTEM-RULES.md#comment_standards`
|
|
81
|
+
|
|
82
|
+
## Comment Rules Quick Reference
|
|
83
|
+
|
|
84
|
+
| ✅ DO | ❌ DON'T |
|
|
85
|
+
|-------|----------|
|
|
86
|
+
| Explain WHY | State the obvious |
|
|
87
|
+
| Document business rules | Comment out dead code |
|
|
88
|
+
| Warn about side effects | Write misleading comments |
|
|
89
|
+
| Explain complex logic | Add noise comments |
|
|
90
|
+
| Add TODO with ticket | Write journal comments |
|
|
91
|
+
|
|
92
|
+
Full guidelines: `SYSTEM-RULES.md#comment_standards`
|
|
93
|
+
|
|
94
|
+
## Khi Nào Cần Đọc Lại
|
|
95
|
+
|
|
96
|
+
| Trigger | Cần refresh |
|
|
97
|
+
|---------|-------------|
|
|
98
|
+
| Bắt đầu session mới | `TRACKER.md`, `HANDOFF.json` |
|
|
99
|
+
| Chuyển phase | `ROADMAP.md` section của phase mới |
|
|
100
|
+
| Gặp lỗi architecture | `ARCHITECTURE.md`, `SYSTEM-RULES.md` |
|
|
101
|
+
| Không rõ business rule | `PROJECT-CONTEXT.md` |
|
|
102
|
+
| Cần quyết định mới | `TRACKER.md` → Decision Log |
|
|
103
|
+
|
|
104
|
+
## Commands Reference
|
|
105
|
+
|
|
106
|
+
| Command | Dùng khi |
|
|
107
|
+
|---------|----------|
|
|
108
|
+
| `/vp-status` | Xem progress nhanh |
|
|
109
|
+
| `/vp-auto` | Chạy autonomous |
|
|
110
|
+
| `/vp-pause` | Dừng, lưu state |
|
|
111
|
+
| `/vp-resume` | Tiếp tục từ pause |
|
|
112
|
+
| `/vp-evolve` | Thêm features/milestone mới |
|
|
113
|
+
| `/vp-docs` | Generate documentation |
|
|
114
|
+
| `/vp-task` | Quản lý task thủ công |
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} - Architecture
|
|
2
|
+
|
|
3
|
+
## System Overview
|
|
4
|
+
|
|
5
|
+
{{SYSTEM_OVERVIEW_DESCRIPTION}}
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
{{SYSTEM_DIAGRAM}}
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Services
|
|
12
|
+
|
|
13
|
+
{{#SERVICES}}
|
|
14
|
+
### {{SERVICE_NAME}}
|
|
15
|
+
- **Purpose**: {{SERVICE_PURPOSE}}
|
|
16
|
+
- **Inputs**: {{SERVICE_INPUTS}}
|
|
17
|
+
- **Outputs**: {{SERVICE_OUTPUTS}}
|
|
18
|
+
- **Dependencies**: {{SERVICE_DEPENDENCIES}}
|
|
19
|
+
- **API**: {{SERVICE_API_TYPE}}
|
|
20
|
+
- **Scaling**: {{SERVICE_SCALING}}
|
|
21
|
+
{{/SERVICES}}
|
|
22
|
+
|
|
23
|
+
## Data Flow
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
{{DATA_FLOW_DIAGRAM}}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Integration Points
|
|
30
|
+
|
|
31
|
+
| Service A | Service B | Protocol | Endpoint/Topic |
|
|
32
|
+
|-----------|-----------|----------|----------------|
|
|
33
|
+
{{INTEGRATION_POINTS}}
|
|
34
|
+
|
|
35
|
+
## Technology Decisions
|
|
36
|
+
|
|
37
|
+
| Decision | Choice | Rationale | Alternatives Considered |
|
|
38
|
+
|----------|--------|-----------|------------------------|
|
|
39
|
+
{{TECHNOLOGY_DECISIONS}}
|
|
40
|
+
|
|
41
|
+
## Database Architecture
|
|
42
|
+
|
|
43
|
+
### Primary Database
|
|
44
|
+
- **Type**: {{DB_TYPE}}
|
|
45
|
+
- **Purpose**: {{DB_PURPOSE}}
|
|
46
|
+
|
|
47
|
+
### Cache
|
|
48
|
+
- **Type**: {{CACHE_TYPE}}
|
|
49
|
+
- **Purpose**: {{CACHE_PURPOSE}}
|
|
50
|
+
|
|
51
|
+
## Security Architecture
|
|
52
|
+
|
|
53
|
+
### Authentication
|
|
54
|
+
{{AUTH_DESCRIPTION}}
|
|
55
|
+
|
|
56
|
+
### Authorization
|
|
57
|
+
{{AUTHZ_DESCRIPTION}}
|
|
58
|
+
|
|
59
|
+
## Deployment Architecture
|
|
60
|
+
|
|
61
|
+
```
|
|
62
|
+
{{DEPLOYMENT_DIAGRAM}}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Monitoring & Observability
|
|
66
|
+
|
|
67
|
+
- **Logging**: {{LOGGING_SOLUTION}}
|
|
68
|
+
- **Metrics**: {{METRICS_SOLUTION}}
|
|
69
|
+
- **Tracing**: {{TRACING_SOLUTION}}
|
|
70
|
+
- **Alerting**: {{ALERTING_SOLUTION}}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- Initial project setup via ViePilot
|
|
12
|
+
|
|
13
|
+
### Changed
|
|
14
|
+
|
|
15
|
+
### Deprecated
|
|
16
|
+
|
|
17
|
+
### Removed
|
|
18
|
+
|
|
19
|
+
### Fixed
|
|
20
|
+
|
|
21
|
+
### Security
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## [{{VERSION}}] - {{DATE}}
|
|
26
|
+
|
|
27
|
+
### Added
|
|
28
|
+
- Project initialization
|
|
29
|
+
- Architecture documentation
|
|
30
|
+
- Development roadmap
|
|
31
|
+
- Coding standards and guidelines
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
[Unreleased]: {{REPOSITORY_URL}}/compare/v{{VERSION}}...HEAD
|
|
36
|
+
[{{VERSION}}]: {{REPOSITORY_URL}}/releases/tag/v{{VERSION}}
|
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
# Contributing to {{PROJECT_NAME}}
|
|
2
|
+
|
|
3
|
+
Thank you for your interest in contributing! This document provides guidelines and standards for contributing to the project.
|
|
4
|
+
|
|
5
|
+
## Table of Contents
|
|
6
|
+
- [Code of Conduct](#code-of-conduct)
|
|
7
|
+
- [Getting Started](#getting-started)
|
|
8
|
+
- [Development Workflow](#development-workflow)
|
|
9
|
+
- [Commit Guidelines](#commit-guidelines)
|
|
10
|
+
- [Pull Request Process](#pull-request-process)
|
|
11
|
+
- [Code Standards](#code-standards)
|
|
12
|
+
- [Recognition](#recognition)
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Code of Conduct
|
|
17
|
+
|
|
18
|
+
We are committed to providing a welcoming and inclusive environment. Please be respectful and constructive in all interactions.
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Getting Started
|
|
23
|
+
|
|
24
|
+
### Prerequisites
|
|
25
|
+
{{PREREQUISITES}}
|
|
26
|
+
|
|
27
|
+
### Setup
|
|
28
|
+
```bash
|
|
29
|
+
# Clone repository
|
|
30
|
+
git clone {{REPOSITORY_URL}}
|
|
31
|
+
cd {{ARTIFACT_ID}}
|
|
32
|
+
|
|
33
|
+
# Setup instructions
|
|
34
|
+
{{SETUP_INSTRUCTIONS}}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## Development Workflow
|
|
40
|
+
|
|
41
|
+
### Branch Naming
|
|
42
|
+
```
|
|
43
|
+
<type>/<short-description>
|
|
44
|
+
|
|
45
|
+
Examples:
|
|
46
|
+
- feat/user-authentication
|
|
47
|
+
- fix/login-bug
|
|
48
|
+
- docs/api-reference
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Workflow
|
|
52
|
+
1. Create branch from `main` or `develop`
|
|
53
|
+
2. Make changes with atomic commits
|
|
54
|
+
3. Write/update tests
|
|
55
|
+
4. Create Pull Request
|
|
56
|
+
5. Pass CI checks
|
|
57
|
+
6. Get review approval
|
|
58
|
+
7. Squash and merge
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## Commit Guidelines
|
|
63
|
+
|
|
64
|
+
We follow [Conventional Commits](https://www.conventionalcommits.org/).
|
|
65
|
+
|
|
66
|
+
### Format
|
|
67
|
+
```
|
|
68
|
+
<type>(<scope>): <subject>
|
|
69
|
+
|
|
70
|
+
[optional body]
|
|
71
|
+
|
|
72
|
+
[optional footer]
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Types
|
|
76
|
+
| Type | Description |
|
|
77
|
+
|------|-------------|
|
|
78
|
+
| `feat` | New feature |
|
|
79
|
+
| `fix` | Bug fix |
|
|
80
|
+
| `docs` | Documentation |
|
|
81
|
+
| `style` | Formatting |
|
|
82
|
+
| `refactor` | Code refactoring |
|
|
83
|
+
| `test` | Tests |
|
|
84
|
+
| `chore` | Maintenance |
|
|
85
|
+
|
|
86
|
+
### Examples
|
|
87
|
+
```bash
|
|
88
|
+
feat(auth): add JWT token refresh
|
|
89
|
+
fix(api): resolve null pointer in user service
|
|
90
|
+
docs(readme): update installation steps
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
## Pull Request Process
|
|
96
|
+
|
|
97
|
+
### PR Title Format
|
|
98
|
+
Same as commit message: `<type>(<scope>): <description>`
|
|
99
|
+
|
|
100
|
+
### PR Checklist
|
|
101
|
+
- [ ] Code follows project style guidelines
|
|
102
|
+
- [ ] Self-review performed
|
|
103
|
+
- [ ] Tests added/updated
|
|
104
|
+
- [ ] Documentation updated
|
|
105
|
+
- [ ] No new warnings
|
|
106
|
+
- [ ] All tests pass
|
|
107
|
+
|
|
108
|
+
### Review Criteria
|
|
109
|
+
- Code quality and readability
|
|
110
|
+
- Test coverage
|
|
111
|
+
- Documentation
|
|
112
|
+
- Performance impact
|
|
113
|
+
- Security considerations
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## Code Standards
|
|
118
|
+
|
|
119
|
+
Please refer to [SYSTEM-RULES.md](/.viepilot/SYSTEM-RULES.md) for complete coding standards including:
|
|
120
|
+
|
|
121
|
+
- Architecture rules
|
|
122
|
+
- Coding conventions
|
|
123
|
+
- Comment standards
|
|
124
|
+
- Testing requirements
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
## Recognition
|
|
129
|
+
|
|
130
|
+
### How We Recognize Contributors
|
|
131
|
+
|
|
132
|
+
1. **CONTRIBUTORS.md** - All contributors listed
|
|
133
|
+
2. **Commit Co-authors** - For pair programming
|
|
134
|
+
3. **Release Notes** - Credits for significant contributions
|
|
135
|
+
|
|
136
|
+
### Contribution Types
|
|
137
|
+
| Emoji | Type |
|
|
138
|
+
|-------|------|
|
|
139
|
+
| 💻 | Code |
|
|
140
|
+
| 📖 | Documentation |
|
|
141
|
+
| 🐛 | Bug Reports |
|
|
142
|
+
| 💡 | Ideas |
|
|
143
|
+
| 🔍 | Code Review |
|
|
144
|
+
| 🧪 | Testing |
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Questions?
|
|
149
|
+
|
|
150
|
+
- Open an issue for bugs/features
|
|
151
|
+
- Start a discussion for questions
|
|
152
|
+
- Contact: {{LEAD_DEVELOPER_EMAIL}}
|
|
153
|
+
|
|
154
|
+
Thank you for contributing! 🙏
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Contributors
|
|
2
|
+
|
|
3
|
+
This project exists thanks to all the people who contribute.
|
|
4
|
+
|
|
5
|
+
## Maintainers
|
|
6
|
+
|
|
7
|
+
| Name | Role | GitHub | Since |
|
|
8
|
+
|------|------|--------|-------|
|
|
9
|
+
| {{LEAD_DEVELOPER_NAME}} | Project Lead | [@{{LEAD_DEVELOPER_GITHUB}}](https://github.com/{{LEAD_DEVELOPER_GITHUB}}) | {{INCEPTION_YEAR}} |
|
|
10
|
+
|
|
11
|
+
## Contributors
|
|
12
|
+
|
|
13
|
+
<!-- ALL-CONTRIBUTORS-LIST:START -->
|
|
14
|
+
| Avatar | Name | Contributions |
|
|
15
|
+
|--------|------|---------------|
|
|
16
|
+
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
17
|
+
|
|
18
|
+
## Contribution Legend
|
|
19
|
+
|
|
20
|
+
| Emoji | Type |
|
|
21
|
+
|-------|------|
|
|
22
|
+
| 💻 | Code |
|
|
23
|
+
| 📖 | Documentation |
|
|
24
|
+
| 🐛 | Bug reports |
|
|
25
|
+
| 💡 | Ideas & Planning |
|
|
26
|
+
| 🔍 | Code Review |
|
|
27
|
+
| 🧪 | Testing |
|
|
28
|
+
| 🎨 | Design |
|
|
29
|
+
| 🚧 | Maintenance |
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## How to Add Yourself
|
|
34
|
+
|
|
35
|
+
After your PR is merged, add yourself to this file:
|
|
36
|
+
|
|
37
|
+
```markdown
|
|
38
|
+
| <img src="your_avatar_url" width="50"> | Your Name | 💻 |
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Or maintainers will add you during release preparation.
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} - Project Context
|
|
2
|
+
|
|
3
|
+
<domain_knowledge>
|
|
4
|
+
## What This System Does
|
|
5
|
+
|
|
6
|
+
{{SYSTEM_DESCRIPTION}}
|
|
7
|
+
|
|
8
|
+
## Key Concepts
|
|
9
|
+
|
|
10
|
+
| Term | Definition |
|
|
11
|
+
|------|------------|
|
|
12
|
+
{{KEY_CONCEPTS}}
|
|
13
|
+
|
|
14
|
+
## Business Rules
|
|
15
|
+
|
|
16
|
+
{{BUSINESS_RULES}}
|
|
17
|
+
|
|
18
|
+
## Data Relationships
|
|
19
|
+
|
|
20
|
+
{{DATA_RELATIONSHIPS}}
|
|
21
|
+
</domain_knowledge>
|
|
22
|
+
|
|
23
|
+
<conventions>
|
|
24
|
+
## Naming Conventions
|
|
25
|
+
|
|
26
|
+
### Code
|
|
27
|
+
- Classes: PascalCase
|
|
28
|
+
- Methods: camelCase
|
|
29
|
+
- Constants: UPPER_SNAKE_CASE
|
|
30
|
+
- Database tables: snake_case
|
|
31
|
+
|
|
32
|
+
### Project Specific
|
|
33
|
+
{{PROJECT_SPECIFIC_CONVENTIONS}}
|
|
34
|
+
|
|
35
|
+
## Code Patterns
|
|
36
|
+
|
|
37
|
+
### Preferred Patterns
|
|
38
|
+
{{PREFERRED_PATTERNS}}
|
|
39
|
+
|
|
40
|
+
### Anti-patterns to Avoid
|
|
41
|
+
{{ANTI_PATTERNS}}
|
|
42
|
+
</conventions>
|
|
43
|
+
|
|
44
|
+
<constraints>
|
|
45
|
+
## Must Have
|
|
46
|
+
|
|
47
|
+
{{MUST_HAVE_CONSTRAINTS}}
|
|
48
|
+
|
|
49
|
+
## Must NOT
|
|
50
|
+
|
|
51
|
+
{{MUST_NOT_CONSTRAINTS}}
|
|
52
|
+
|
|
53
|
+
## Performance Requirements
|
|
54
|
+
|
|
55
|
+
{{PERFORMANCE_REQUIREMENTS}}
|
|
56
|
+
|
|
57
|
+
## Security Requirements
|
|
58
|
+
|
|
59
|
+
{{SECURITY_REQUIREMENTS}}
|
|
60
|
+
</constraints>
|
|
61
|
+
|
|
62
|
+
<external_dependencies>
|
|
63
|
+
## Third-party Services
|
|
64
|
+
|
|
65
|
+
| Service | Purpose | Documentation |
|
|
66
|
+
|---------|---------|---------------|
|
|
67
|
+
{{EXTERNAL_SERVICES}}
|
|
68
|
+
|
|
69
|
+
## Libraries & Frameworks
|
|
70
|
+
|
|
71
|
+
| Library | Version | Purpose |
|
|
72
|
+
|---------|---------|---------|
|
|
73
|
+
{{LIBRARIES}}
|
|
74
|
+
</external_dependencies>
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} - Project Metadata
|
|
2
|
+
|
|
3
|
+
> File này chứa thông tin cơ bản về dự án.
|
|
4
|
+
> AI đọc file này để generate đúng package, headers, attribution.
|
|
5
|
+
|
|
6
|
+
## Project Info
|
|
7
|
+
|
|
8
|
+
| Field | Value |
|
|
9
|
+
|-------|-------|
|
|
10
|
+
| **Name** | {{PROJECT_NAME}} |
|
|
11
|
+
| **Description** | {{PROJECT_DESCRIPTION}} |
|
|
12
|
+
| **Inception Year** | {{INCEPTION_YEAR}} |
|
|
13
|
+
| **License** | {{LICENSE}} |
|
|
14
|
+
|
|
15
|
+
## Organization
|
|
16
|
+
|
|
17
|
+
| Field | Value |
|
|
18
|
+
|-------|-------|
|
|
19
|
+
| **Name** | {{ORGANIZATION_NAME}} |
|
|
20
|
+
| **Website** | {{ORGANIZATION_URL}} |
|
|
21
|
+
|
|
22
|
+
## Package Structure
|
|
23
|
+
|
|
24
|
+
| Field | Value |
|
|
25
|
+
|-------|-------|
|
|
26
|
+
| **Base Package** | `{{PACKAGE_BASE_ID}}` |
|
|
27
|
+
| **Group ID** | `{{GROUP_ID}}` |
|
|
28
|
+
| **Artifact ID** | `{{ARTIFACT_ID}}` |
|
|
29
|
+
|
|
30
|
+
### Module Packages
|
|
31
|
+
```
|
|
32
|
+
{{PACKAGE_BASE_ID}}
|
|
33
|
+
├── common # Shared modules
|
|
34
|
+
│ ├── model # Shared entities, DTOs
|
|
35
|
+
│ └── util # Shared utilities
|
|
36
|
+
├── {{MODULE_1}} # Module 1
|
|
37
|
+
│ ├── controller
|
|
38
|
+
│ ├── service
|
|
39
|
+
│ ├── mapper
|
|
40
|
+
│ └── ...
|
|
41
|
+
├── {{MODULE_2}} # Module 2
|
|
42
|
+
└── ...
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Developers
|
|
46
|
+
|
|
47
|
+
### Lead Developer
|
|
48
|
+
| Field | Value |
|
|
49
|
+
|-------|-------|
|
|
50
|
+
| **Name** | {{LEAD_DEVELOPER_NAME}} |
|
|
51
|
+
| **Email** | {{LEAD_DEVELOPER_EMAIL}} |
|
|
52
|
+
| **GitHub** | [@{{LEAD_DEVELOPER_GITHUB}}](https://github.com/{{LEAD_DEVELOPER_GITHUB}}) |
|
|
53
|
+
| **Role** | Project Lead, Core Developer |
|
|
54
|
+
|
|
55
|
+
### Contributors
|
|
56
|
+
See [CONTRIBUTORS.md](/CONTRIBUTORS.md)
|
|
57
|
+
|
|
58
|
+
## Repository
|
|
59
|
+
|
|
60
|
+
| Field | Value |
|
|
61
|
+
|-------|-------|
|
|
62
|
+
| **URL** | {{REPOSITORY_URL}} |
|
|
63
|
+
| **Issues** | {{ISSUE_TRACKER_URL}} |
|
|
64
|
+
| **CI/CD** | {{CI_CD_SYSTEM}} |
|
|
65
|
+
|
|
66
|
+
## File Headers
|
|
67
|
+
|
|
68
|
+
### Java File Header
|
|
69
|
+
```java
|
|
70
|
+
/*
|
|
71
|
+
* {{PROJECT_NAME}}
|
|
72
|
+
* Copyright (c) {{INCEPTION_YEAR}} {{ORGANIZATION_NAME}}
|
|
73
|
+
*
|
|
74
|
+
* Licensed under the {{LICENSE}} License.
|
|
75
|
+
* See LICENSE file in the project root for full license information.
|
|
76
|
+
*/
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### SQL File Header
|
|
80
|
+
```sql
|
|
81
|
+
-- {{PROJECT_NAME}}
|
|
82
|
+
-- Copyright (c) {{INCEPTION_YEAR}} {{ORGANIZATION_NAME}}
|
|
83
|
+
-- Licensed under {{LICENSE}} License
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### Configuration File Header
|
|
87
|
+
```yaml
|
|
88
|
+
# {{PROJECT_NAME}}
|
|
89
|
+
# Copyright (c) {{INCEPTION_YEAR}} {{ORGANIZATION_NAME}}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Shell Script Header
|
|
93
|
+
```bash
|
|
94
|
+
#!/bin/bash
|
|
95
|
+
# {{PROJECT_NAME}}
|
|
96
|
+
# Copyright (c) {{INCEPTION_YEAR}} {{ORGANIZATION_NAME}}
|
|
97
|
+
# Licensed under {{LICENSE}} License
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Author Tag (for Javadoc)
|
|
101
|
+
```java
|
|
102
|
+
/**
|
|
103
|
+
* Description of the class.
|
|
104
|
+
*
|
|
105
|
+
* @author {{LEAD_DEVELOPER_NAME}}
|
|
106
|
+
* @since {{VERSION}}
|
|
107
|
+
*/
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Maven POM Template
|
|
111
|
+
```xml
|
|
112
|
+
<groupId>{{GROUP_ID}}</groupId>
|
|
113
|
+
<artifactId>{{ARTIFACT_ID}}</artifactId>
|
|
114
|
+
<version>{{VERSION}}</version>
|
|
115
|
+
|
|
116
|
+
<name>{{PROJECT_NAME}}</name>
|
|
117
|
+
<description>{{PROJECT_DESCRIPTION}}</description>
|
|
118
|
+
<url>{{REPOSITORY_URL}}</url>
|
|
119
|
+
<inceptionYear>{{INCEPTION_YEAR}}</inceptionYear>
|
|
120
|
+
|
|
121
|
+
<organization>
|
|
122
|
+
<name>{{ORGANIZATION_NAME}}</name>
|
|
123
|
+
<url>{{ORGANIZATION_URL}}</url>
|
|
124
|
+
</organization>
|
|
125
|
+
|
|
126
|
+
<developers>
|
|
127
|
+
<developer>
|
|
128
|
+
<id>{{LEAD_DEVELOPER_GITHUB}}</id>
|
|
129
|
+
<name>{{LEAD_DEVELOPER_NAME}}</name>
|
|
130
|
+
<email>{{LEAD_DEVELOPER_EMAIL}}</email>
|
|
131
|
+
</developer>
|
|
132
|
+
</developers>
|
|
133
|
+
```
|