aiwf 0.1.0 → 0.3.1
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 +46 -0
- package/CLAUDE.md +19 -0
- package/LICENSE +1 -1
- package/README.ko.md +90 -62
- package/README.md +109 -62
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/01_PROJECT_DOCS/ARCHITECTURE.md +1 -1
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/M01_Backend_Setup/M01_milestone_meta.md +5 -1
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/M01_Backend_Setup/PRD_AMEND_01_Auth_Flow_Update.md +5 -1
- package/claude-code/{simone/.simone/03_SPRINTS/CLAUDE.MD → aiwf/en/.aiwf/03_SPRINTS/CLAUDE.md} +28 -7
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/03_SPRINTS/S01_M01_Initial_API/S01_sprint_meta.md +8 -1
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/03_SPRINTS/S01_M01_Initial_API/T01_S01_Setup_Project_Structure.md +5 -1
- package/claude-code/aiwf/en/.aiwf/04_GENERAL_TASKS/CLAUDE.md +96 -0
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/04_GENERAL_TASKS/T002_API_Rate_Limiting.md +7 -2
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/04_GENERAL_TASKS/TX001_Refactor_Logging_Module.md +7 -2
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/05_ARCHITECTURAL_DECISIONS/ADR001_Chosen_Database_System.md +7 -1
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/05_ARCHITECTURAL_DECISIONS/ADR002_API_Authentication_Method.md +7 -1
- package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-12-12-00-needs-focus.md +139 -0
- package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-12-12-00-test-alignment.md +155 -0
- package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-13-00-50-solid-progress.md +122 -0
- package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-14-08-30-infrastructure-challenges.md +141 -0
- package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-16-21-48-critical-foundation-issues.md +177 -0
- package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-17-15-08-solid-progress.md +149 -0
- package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/index.json +5 -0
- package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/sync-index.js +78 -0
- package/claude-code/aiwf/en/.aiwf/98_PROMPTS/github_integration.md +130 -0
- package/claude-code/aiwf/en/.aiwf/98_PROMPTS/useful-prompts.md +31 -0
- package/claude-code/aiwf/en/.aiwf/98_PROMPTS/vibe-front-prompts.md +89 -0
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/task_template.md +1 -0
- package/claude-code/{simone/.simone/CLAUDE.MD → aiwf/en/.aiwf/CLAUDE.md} +13 -4
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/README.md +6 -6
- package/claude-code/aiwf/en/.claude/CLAUDE_BE.md +276 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_changelog.md +82 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_code_review.md +88 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_commit.md +160 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_general_task.md +147 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_milestone_plan.md +194 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_prd.md +272 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_sprint_tasks.md +189 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_sprints_from_milestone.md +121 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_discuss_review.md +29 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_do_task.md +109 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_docs.md +225 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_infinite.md +202 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_initialize.md +134 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_issue_create.md +65 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_language_manager.md +287 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_language_status.md +246 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_mermaid.md +272 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_pr_create.md +76 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_prime.md +9 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_project_review.md +261 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_switch_language.md +160 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_test.md +125 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_testing_review.md +198 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_tm-run-all-subtask.md +206 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_ultrathink_code_advanced.md +460 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_ultrathink_code_basic.md +165 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_ultrathink_general.md +362 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_yolo.md +300 -0
- package/claude-code/aiwf/en/.claude/mcp.json +31 -0
- package/claude-code/aiwf/en/.claude/settings.json +102 -0
- package/claude-code/aiwf/ko/.aiwf/00_PROJECT_MANIFEST.md +49 -0
- package/claude-code/aiwf/ko/.aiwf/01_PROJECT_DOCS/ARCHITECTURE.md +55 -0
- package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/CLAUDE.md +78 -0
- package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/M01_Backend_Setup/M01_milestone_meta.md +42 -0
- package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/M01_Backend_Setup/PRD_AMEND_01_Auth_Flow_Update.md +73 -0
- package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/M01_Backend_Setup/PRD_Backend_Setup.md +98 -0
- package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/M01_Backend_Setup/SPECS_API_V1.md +232 -0
- package/claude-code/aiwf/ko/.aiwf/03_SPRINTS/CLAUDE.md +83 -0
- package/claude-code/aiwf/ko/.aiwf/03_SPRINTS/S01_M01_Initial_API/S01_sprint_meta.md +49 -0
- package/claude-code/aiwf/ko/.aiwf/03_SPRINTS/S01_M01_Initial_API/T01_S01_Setup_Project_Structure.md +60 -0
- package/claude-code/aiwf/ko/.aiwf/04_GENERAL_TASKS/CLAUDE.md +96 -0
- package/claude-code/aiwf/ko/.aiwf/04_GENERAL_TASKS/T002_API_Rate_Limiting.md +54 -0
- package/claude-code/aiwf/ko/.aiwf/04_GENERAL_TASKS/TX001_Refactor_Logging_Module.md +58 -0
- package/claude-code/aiwf/ko/.aiwf/05_ARCHITECTURAL_DECISIONS/ADR001_Chosen_Database_System.md +119 -0
- package/claude-code/aiwf/ko/.aiwf/05_ARCHITECTURAL_DECISIONS/ADR002_API_Authentication_Method.md +124 -0
- package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-12-12-00-needs-focus.md +139 -0
- package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-12-12-00-test-alignment.md +155 -0
- package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-13-00-50-solid-progress.md +122 -0
- package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-14-08-30-infrastructure-challenges.md +141 -0
- package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-16-21-48-critical-foundation-issues.md +177 -0
- package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-17-15-08-solid-progress.md +149 -0
- package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/index.json +5 -0
- package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/sync-index.js +78 -0
- package/claude-code/aiwf/ko/.aiwf/98_PROMPTS/github_integration.md +130 -0
- package/claude-code/aiwf/ko/.aiwf/98_PROMPTS/useful-prompts.md +31 -0
- package/claude-code/aiwf/ko/.aiwf/98_PROMPTS/vibe-front-prompts.md +89 -0
- package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/adr_template.md +49 -0
- package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/milestone_meta_template.md +25 -0
- package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/project_manifest_template.md +39 -0
- package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/sprint_meta_template.md +23 -0
- package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/task_template.md +36 -0
- package/claude-code/aiwf/ko/.aiwf/CLAUDE.md +76 -0
- package/claude-code/aiwf/ko/.aiwf/README.md +97 -0
- package/claude-code/aiwf/ko/.claude/CLAUDE_BE.md +276 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_changelog.md +82 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_code_review.md +88 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_commit.md +160 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_general_task.md +147 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_milestone_plan.md +194 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_prd.md +280 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_sprint_tasks.md +189 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_sprints_from_milestone.md +121 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_discuss_review.md +29 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_do_task.md +109 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_docs.md +225 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_infinite.md +202 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_initialize.md +134 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_issue_create.md +65 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_language_manager.md +287 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_language_status.md +246 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_mermaid.md +272 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_pr_create.md +76 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_prime.md +9 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_project_review.md +261 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_switch_language.md +160 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_test.md +124 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_testing_review.md +198 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_tm-run-all-subtask.md +210 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_ultrathink_code_advanced.md +460 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_ultrathink_code_basic.md +165 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_ultrathink_general.md +305 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_yolo.md +300 -0
- package/claude-code/aiwf/ko/.claude/mcp.json +31 -0
- package/claude-code/aiwf/ko/.claude/settings.json +102 -0
- package/{AI-WORKFLOW.md → docs/AI-WORKFLOW.ko.md} +38 -24
- package/docs/AI-WORKFLOW.md +299 -0
- package/docs/COMMANDS_GUIDE.ko.md +727 -0
- package/docs/COMMANDS_GUIDE.md +726 -0
- package/docs/CONTRIBUTING.md +406 -0
- package/docs/DEVELOPMENT_GUIDE.md +727 -0
- package/docs/Enhanced_Installation_Flow_Design.md +498 -0
- package/docs/PRD.ko.md +148 -0
- package/docs/PRD.md +150 -0
- package/docs/moonklabs-metadata-system-prd.md +127 -0
- package/index.js +1493 -122
- package/jest.config.js +4 -0
- package/language-cli.js +279 -0
- package/language-utils.js +330 -0
- package/package.json +23 -10
- package/scripts/validate-commands.cjs +338 -0
- package/scripts/validate-commands.js +254 -0
- package/tests/basic.test.js +62 -0
- package/tests/commands.test.js +127 -0
- package/tests/installer.test.js +129 -0
- package/tests/language-utils.test.js +271 -0
- package/COMMANDS_GUIDE.md +0 -462
- package/PRD.ko.md +0 -96
- package/PRD.md +0 -98
- package/claude-code/simone/.simone/04_GENERAL_TASKS/CLAUDE.MD +0 -51
- package/claude-code/simone/CHANGELOG.md +0 -71
- package/claude-code/simone/LICENSE +0 -21
- package/claude-code/simone/README.md +0 -219
- package/claude-code/simone/SYNC_GUIDE.md +0 -172
- package/claude-code/simone/sync-simone.sh +0 -138
- /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/00_PROJECT_MANIFEST.md +0 -0
- /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/CLAUDE.md +0 -0
- /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/M01_Backend_Setup/PRD_Backend_Setup.md +0 -0
- /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/M01_Backend_Setup/SPECS_API_V1.md +0 -0
- /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/adr_template.md +0 -0
- /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/milestone_meta_template.md +0 -0
- /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/project_manifest_template.md +0 -0
- /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/sprint_meta_template.md +0 -0
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
# GitHub Integration with AIWF Framework
|
|
2
|
+
|
|
3
|
+
This document provides guidance on integrating GitHub issues and pull requests with the AIWF task management system.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
The AIWF framework now supports seamless integration with GitHub issues and pull requests, enabling better tracking and collaboration through the `gh` CLI tool.
|
|
8
|
+
|
|
9
|
+
## Key Features
|
|
10
|
+
|
|
11
|
+
### 1. Task-Issue Linking
|
|
12
|
+
|
|
13
|
+
- Each task can be linked to a GitHub issue via the `github_issue` field in frontmatter
|
|
14
|
+
- Automatic status synchronization between tasks and issues
|
|
15
|
+
- Bidirectional updates ensure consistency
|
|
16
|
+
|
|
17
|
+
### 2. Automated Workflows
|
|
18
|
+
|
|
19
|
+
- Create GitHub issues from tasks: `/project:aiwf:issue_create {task_id}`
|
|
20
|
+
- Generate pull requests with issue linking: `/project:aiwf:pr_create {task_id}`
|
|
21
|
+
- Commit messages automatically include issue references
|
|
22
|
+
|
|
23
|
+
### 3. Status Management
|
|
24
|
+
|
|
25
|
+
- Task status changes trigger GitHub issue updates
|
|
26
|
+
- Issues are labeled based on task status (in-progress, completed, etc.)
|
|
27
|
+
- Comments are added to issues for transparency
|
|
28
|
+
|
|
29
|
+
## Commands Reference
|
|
30
|
+
|
|
31
|
+
### Issue Creation
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
/project:aiwf:issue_create {task_id}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Creates a GitHub issue from a task file with:
|
|
38
|
+
|
|
39
|
+
- Title including task ID
|
|
40
|
+
- Description from task content
|
|
41
|
+
- Appropriate labels
|
|
42
|
+
- Automatic assignment
|
|
43
|
+
|
|
44
|
+
### Pull Request Creation
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
/project:aiwf:pr_create {task_id}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Creates a pull request that:
|
|
51
|
+
|
|
52
|
+
- Links to the associated issue
|
|
53
|
+
- Includes commit history
|
|
54
|
+
- Auto-closes issue on merge
|
|
55
|
+
- Assigns reviewers
|
|
56
|
+
|
|
57
|
+
### Manual GitHub Commands
|
|
58
|
+
|
|
59
|
+
Update issue status:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
gh issue comment {issue_number} --body "Status update message"
|
|
63
|
+
gh issue edit {issue_number} --add-label "label-name"
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Create issue manually:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
gh issue create \
|
|
70
|
+
--title "Task: Description" \
|
|
71
|
+
--body "Detailed description" \
|
|
72
|
+
--label "task,sprint-01"
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Best Practices
|
|
76
|
+
|
|
77
|
+
### 1. Issue Creation Timing
|
|
78
|
+
|
|
79
|
+
- Create issues when starting a sprint
|
|
80
|
+
- Link issues immediately after creation
|
|
81
|
+
- Update frontmatter with issue number
|
|
82
|
+
|
|
83
|
+
### 2. Commit Messages
|
|
84
|
+
|
|
85
|
+
- Use `fixes #123` for bug fixes
|
|
86
|
+
- Use `relates to #123` for partial work
|
|
87
|
+
- Include task ID in commit message
|
|
88
|
+
|
|
89
|
+
### 3. Pull Request Workflow
|
|
90
|
+
|
|
91
|
+
- Create PR after task completion
|
|
92
|
+
- Ensure all tests pass
|
|
93
|
+
- Link to original issue
|
|
94
|
+
- Request appropriate reviewers
|
|
95
|
+
|
|
96
|
+
## Integration Points
|
|
97
|
+
|
|
98
|
+
### Task Files
|
|
99
|
+
|
|
100
|
+
Add to frontmatter:
|
|
101
|
+
|
|
102
|
+
```yaml
|
|
103
|
+
github_issue: #123
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Sprint Planning
|
|
107
|
+
|
|
108
|
+
- Create issues for all tasks at sprint start
|
|
109
|
+
- Use labels to group by sprint
|
|
110
|
+
- Track progress via GitHub Projects
|
|
111
|
+
|
|
112
|
+
### YOLO Mode
|
|
113
|
+
|
|
114
|
+
- Automatically creates issues if enabled
|
|
115
|
+
- Creates PRs after successful commits
|
|
116
|
+
- Maintains full automation flow
|
|
117
|
+
|
|
118
|
+
## Troubleshooting
|
|
119
|
+
|
|
120
|
+
### Common Issues
|
|
121
|
+
|
|
122
|
+
1. **Missing gh CLI**: Install GitHub CLI first
|
|
123
|
+
2. **Authentication**: Run `gh auth login`
|
|
124
|
+
3. **Permissions**: Ensure repo access rights
|
|
125
|
+
|
|
126
|
+
### Error Handling
|
|
127
|
+
|
|
128
|
+
- Check task file for valid issue number
|
|
129
|
+
- Verify GitHub API limits
|
|
130
|
+
- Ensure branch protection rules allow automation
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# 유용한 프롬프트
|
|
2
|
+
|
|
3
|
+
## 프로젝트 분석
|
|
4
|
+
|
|
5
|
+
[Ask, sonnet4 그리고 o3 연속으로..]
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
이 프로젝트 구조를 자세히 파악해줘
|
|
9
|
+
코드 컨벤션 스타일 디자인 규칙을 모두 분석해서 자세히 설명해줘
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## 커서 Rule 생성
|
|
13
|
+
|
|
14
|
+
[Agent, sonnet4]
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
/Generate Cursor Rules
|
|
18
|
+
위의 분석한 내용을 기반으로 rule 만들어줘
|
|
19
|
+
내용은 영어로 작성해.
|
|
20
|
+
대표적인 프롬프트 엔지니어링 기법을 적용해서 최적화해줘.
|
|
21
|
+
반드시 지켜야할 규칙, 반드시 하지말아야할 것들을 특히 강조해서 적어줘.
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[Agent, sonnet4]
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
/Generate Cursor Rules
|
|
28
|
+
지금까지 너는 실수를 했지이 실수의 원인을 자세히 분석하고, 로 작성해.
|
|
29
|
+
대표적인 프롬프트 엔지니어링 기법을 적용해서 최적화해줘.
|
|
30
|
+
반드시 지켜야할 규칙, 반드시 하지말아야할 것들을 특히 강조해서 적어줘.
|
|
31
|
+
```
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
# VIBE 코딩 프론트엔드 프롬프트
|
|
2
|
+
|
|
3
|
+
https://github.com/roboco-io/handson-vibecoding-demo
|
|
4
|
+
|
|
5
|
+
## STEP1
|
|
6
|
+
|
|
7
|
+
지금부터 간단한 앱을 만드는 것을 데모로 보여주려 고해. TODO앱을 웹 앱으로 만들려고해. 우선 docs 폴더 아래에 요건 정의를 문서화 해 줘. 요건정의를 위해서 필요한 질문들을 포함해줘.
|
|
8
|
+
|
|
9
|
+
- requirements.md 리뷰
|
|
10
|
+
- .windsurfrules 생성
|
|
11
|
+
|
|
12
|
+
@requirements.md 참고해서 설계문서 작성을 진행해줘
|
|
13
|
+
|
|
14
|
+
- design.dm 리뷰
|
|
15
|
+
mermaid -> svg 로 설계문서를 작성
|
|
16
|
+
|
|
17
|
+
@design.md 에서 아키텍처 다이어그램은 SVG를 사용해서 정확하고 상서하게 그려줘.
|
|
18
|
+
|
|
19
|
+
리퀘스트 처리 부분에 대해서 시퀀스 다이어 그램을 추가해줘. 시퀀스 다이어그램은 mermaid 로 그려줘
|
|
20
|
+
|
|
21
|
+
UI 설계에서 모바일뷰와 데스크톱 뷰의 와이어프레임도 SVG로 생성해줘
|
|
22
|
+
|
|
23
|
+
카드뷰 보다는 리스트로 표시해줘
|
|
24
|
+
|
|
25
|
+
@design.md 문서에 기반해서 앞으로 수행해 야 할 작업들을 순서대로 체크리스트로 만들어 줘. UI/UX를 제외한 코어 비즈니스 로직은 TDD 에 기반해서 작업해야해. 작업이 확인 가능한 단 위별로 커밋 포인트도 체크리스트에 표시해줘.
|
|
26
|
+
|
|
27
|
+
## STEP2
|
|
28
|
+
|
|
29
|
+
나는 좀 더 간편한 UI Kit을 사용해서 프론트를 구현하고 싶어. 어떤 UI Kit이 좋을까?
|
|
30
|
+
|
|
31
|
+
Mantine 을 사용해서 UI를 구현하도록 요건과 설계문서를 업데이트 해줘
|
|
32
|
+
|
|
33
|
+
@implementation-checklist.md 의 이름을 checklist.md 로 바꿔줘
|
|
34
|
+
|
|
35
|
+
업데이트된 @design.md 내용에 맞춰서 @checklist.md 를 업데이트 해줘
|
|
36
|
+
|
|
37
|
+
Windsurf rules 수정 :
|
|
38
|
+
|
|
39
|
+
- 커뮤니케이션은 한국어로 해줘
|
|
40
|
+
- 프론트엔드 UI 구현시에는 실행 코드를 먼저 작성한다. 코어 비즈니스 로직 구현 시에만 TDD로 진행 할 것.
|
|
41
|
+
- 백엔드는 TDD로 구현할 것
|
|
42
|
+
- 커밋 전에 docs/checklist.md에 진행상황을 업데이트 한다.
|
|
43
|
+
- 설계 변경시에는 requirements.md 와 design.md 를 수정한다.
|
|
44
|
+
|
|
45
|
+
업데이트 된 계획들을 커밋해줘
|
|
46
|
+
|
|
47
|
+
이제 체크리스트 항목을 시작해줘
|
|
48
|
+
|
|
49
|
+
프로젝트 설명을 위한 README 를 root 폴더에 만들어줘
|
|
50
|
+
|
|
51
|
+
[자동화]
|
|
52
|
+
Rules 파일은 자동화에 큰 역할을 담당한다
|
|
53
|
+
Awesome cursor rules 를 참고해서 업데이트 해야한다
|
|
54
|
+
|
|
55
|
+
@web https://github.com/PatrickJS/awesome-cursorrules/blob/main/rules/nextjs15-react19-vercelai-tailwind-cursorrules-prompt-file/.cursorrules 참고해서 이 프로젝트의 아키텍처와 요구사항 edesign.md, erequirements.nd 을 반영한 규칙 파일을 edocs 에 windsurfruels.md 에 만들어줘
|
|
56
|
+
|
|
57
|
+
git hook을 이용해서 커밋시에 Iint fix, build, test가 자동으로 수행되도록 하고싶어. 실행 코드에 변경시에만 작동되어야 해.
|
|
58
|
+
우선은 프론트에 대해서 적용해줘
|
|
59
|
+
|
|
60
|
+
체크리스트에 방금 작업한 내용을 반영해줘. 설계문서와 README 에도 반영해줘
|
|
61
|
+
|
|
62
|
+
변경사항을 커밋해줘
|
|
63
|
+
|
|
64
|
+
@pre-commit 을 수정해서 좀 더 디테일한 로그를 남겨서 디버깅을 용이하게 해줘
|
|
65
|
+
|
|
66
|
+
## STEP3
|
|
67
|
+
|
|
68
|
+
[P] 나는 프른트 개발을 독립적으로 완료하고 그 다음 백엔드에 연결하는 방식으로 개발을 하고 싶어.
|
|
69
|
+
|
|
70
|
+
- 관련 체크리스트 조정됨
|
|
71
|
+
|
|
72
|
+
[P] 체크리스트에 따라서 다음 작업을 진행해줘
|
|
73
|
+
|
|
74
|
+
- lint 작성확인
|
|
75
|
+
- npm run lint
|
|
76
|
+
|
|
77
|
+
[P] 이제부터 mantain v7 으로 UI를 구현해줘. 최신버전의 사용법은 @web https://mantine.dev 를 참고해서 구현해줘
|
|
78
|
+
(시안 이미지 복붙후)
|
|
79
|
+
이미지를 참고해서 모바일과 데스크톱 모두 대응되는 반응형 디자인으로 작성해줘.
|
|
80
|
+
이미지는 와이어프레임 이므로 배치만 참고해줘
|
|
81
|
+
|
|
82
|
+
- 공식문서 파일들을 rules에 업데이트 하자
|
|
83
|
+
- 관련 MCP도 업데이트 되고 있으니 참고하자
|
|
84
|
+
|
|
85
|
+
@checklist.md 에 데모로서 불필요한 부분을 삭제했어. 삭제된 내용을 @requirements.md, @design.md 에 반영해줘.
|
|
86
|
+
|
|
87
|
+
@checklist.md 를 보고 다음 구현을 진행해줘. 우선 브라우저 전체 너비를 사용 하도록 레이아웃을 조정해줘. 현재 코드는 고정폭을 사용하고 있어. 수정 하기 전에 관련 코드를 먼저 꼼꼼히 살펴보고 수정을 계획을 세운다음 나에게 확인을 받고 진행 해.
|
|
88
|
+
|
|
89
|
+
- 중간에 헤맬때는 조사를 하라고 시키면 좋다
|
|
@@ -4,6 +4,7 @@ sprint_sequence_id: S<ID> # e.g., S01 (If part of a sprint, otherwise null or ab
|
|
|
4
4
|
status: open # open | in_progress | pending_review | done | failed | blocked
|
|
5
5
|
complexity: Medium # Low | Medium | High
|
|
6
6
|
last_updated: YYYY-MM-DDTHH:MM:SSZ
|
|
7
|
+
github_issue: # Optional: GitHub issue number (e.g., #123)
|
|
7
8
|
---
|
|
8
9
|
|
|
9
10
|
# Task: (Filename serves as the descriptive title)
|
|
@@ -1,30 +1,36 @@
|
|
|
1
|
-
# CLAUDE.md -
|
|
1
|
+
# CLAUDE.md - AIWF Framework Structure Guide
|
|
2
2
|
|
|
3
3
|
## Overview
|
|
4
|
-
|
|
4
|
+
|
|
5
|
+
This is the root directory of the AIWF framework structure. It contains all project documentation, requirements, sprints, and organizational files.
|
|
5
6
|
|
|
6
7
|
## Critical Files
|
|
7
8
|
|
|
8
9
|
### Project Manifest
|
|
10
|
+
|
|
9
11
|
**IMPORTANT**: The project manifest file MUST be named:
|
|
12
|
+
|
|
10
13
|
```
|
|
11
14
|
00_PROJECT_MANIFEST.md
|
|
12
15
|
```
|
|
13
16
|
|
|
14
17
|
**NOT**:
|
|
18
|
+
|
|
15
19
|
- ❌ `MANIFEST.md`
|
|
16
20
|
- ❌ `PROJECT_MANIFEST.md`
|
|
17
21
|
- ❌ `project_manifest.md`
|
|
18
22
|
|
|
19
23
|
The manifest is the central reference file that tracks:
|
|
24
|
+
|
|
20
25
|
- Project name and status
|
|
21
26
|
- Current milestone and sprint
|
|
22
27
|
- Project metadata
|
|
23
28
|
- Last updated timestamp
|
|
24
29
|
|
|
25
30
|
## Directory Structure
|
|
31
|
+
|
|
26
32
|
```
|
|
27
|
-
.
|
|
33
|
+
.AIWF/
|
|
28
34
|
├── 00_PROJECT_MANIFEST.md # Central project reference (CORRECT NAME)
|
|
29
35
|
├── 01_PROJECT_DOCS/ # General project documentation
|
|
30
36
|
├── 02_REQUIREMENTS/ # Milestone-based requirements
|
|
@@ -38,6 +44,7 @@ The manifest is the central reference file that tracks:
|
|
|
38
44
|
## Naming Conventions Summary
|
|
39
45
|
|
|
40
46
|
### Files
|
|
47
|
+
|
|
41
48
|
- **Project Manifest**: `00_PROJECT_MANIFEST.md`
|
|
42
49
|
- **Milestone Meta**: `M##_milestone_meta.md`
|
|
43
50
|
- **Sprint Meta**: `S##_M##_sprint_meta.md`
|
|
@@ -45,6 +52,7 @@ The manifest is the central reference file that tracks:
|
|
|
45
52
|
- **ADR Files**: `ADR_###_*.md`
|
|
46
53
|
|
|
47
54
|
### Folders
|
|
55
|
+
|
|
48
56
|
- **Milestones**: `M##_Milestone_Name/`
|
|
49
57
|
- **Sprints**: `S##_M##_Sprint_Name/`
|
|
50
58
|
- **State Snapshots**: `YYYY-MM-DD_HH-MM_snapshot/`
|
|
@@ -58,8 +66,9 @@ The manifest is the central reference file that tracks:
|
|
|
58
66
|
5. **Use underscores** for spaces in folder and file names
|
|
59
67
|
|
|
60
68
|
## Common Initialization Mistakes
|
|
69
|
+
|
|
61
70
|
- Creating `MANIFEST.md` instead of `00_PROJECT_MANIFEST.md`
|
|
62
71
|
- Missing the leading zeros in numbered prefixes
|
|
63
72
|
- Using hyphens instead of underscores
|
|
64
73
|
- Creating files without using templates
|
|
65
|
-
- Not updating the manifest after structural changes
|
|
74
|
+
- Not updating the manifest after structural changes
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
#
|
|
1
|
+
# AIWF Framework
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
AIWF is a project management system designed to work with Claude Code's strengths and limitations. It provides structure for breaking down software projects into manageable, context-aware tasks.
|
|
4
4
|
|
|
5
5
|
## Core Concept
|
|
6
6
|
|
|
7
|
-
The fundamental challenge: AI context windows are limited and we can't control what information stays or leaves during long sessions.
|
|
7
|
+
The fundamental challenge: AI context windows are limited and we can't control what information stays or leaves during long sessions. AIWF solves this by starting fresh for each task while providing rich, relevant context.
|
|
8
8
|
|
|
9
|
-
## How
|
|
9
|
+
## How AIWF Works
|
|
10
10
|
|
|
11
11
|
### 1. Requirements First
|
|
12
12
|
|
|
@@ -49,7 +49,7 @@ Each task follows a strict workflow:
|
|
|
49
49
|
|
|
50
50
|
### 4. Context Management
|
|
51
51
|
|
|
52
|
-
For each task,
|
|
52
|
+
For each task, AIWF provides:
|
|
53
53
|
|
|
54
54
|
- The specific task description and criteria
|
|
55
55
|
- Relevant sprint and milestone context
|
|
@@ -79,7 +79,7 @@ Built-in review processes maintain standards:
|
|
|
79
79
|
|
|
80
80
|
## Commands Overview
|
|
81
81
|
|
|
82
|
-
|
|
82
|
+
AIWF commands (`/project:AIWF:command`) automate the workflow:
|
|
83
83
|
|
|
84
84
|
- Planning: `plan_milestone`, `create_sprint`
|
|
85
85
|
- Execution: `create_task`, `do_task`, `code_review`
|
|
@@ -0,0 +1,276 @@
|
|
|
1
|
+
# CLAUDE.md
|
|
2
|
+
|
|
3
|
+
IMPORTANT: These are my development preferences and guidelines. YOU MUST follow them when working on my projects.
|
|
4
|
+
site: https://github.com/wcygan/dotfiles
|
|
5
|
+
|
|
6
|
+
## Code Style & Workflow
|
|
7
|
+
|
|
8
|
+
### Testing
|
|
9
|
+
|
|
10
|
+
- **ALWAYS** write clear, descriptive test names for better readability
|
|
11
|
+
- **ALWAYS** prefer running single tests over the whole test suite for performance
|
|
12
|
+
- Use `deno test --filter="test name"` or framework-specific single test runners
|
|
13
|
+
|
|
14
|
+
### Language & Framework Preferences
|
|
15
|
+
|
|
16
|
+
#### Backend Programming
|
|
17
|
+
|
|
18
|
+
IMPORTANT: I am primarily a backend developer and prefer these languages and frameworks:
|
|
19
|
+
|
|
20
|
+
- **Go**: Use [ConnectRPC](https://github.com/connectrpc/connect-go) for RPC services
|
|
21
|
+
- **Rust**: Use [axum](https://github.com/tokio-rs/axum) for web services
|
|
22
|
+
- **Java**: Use [Spring Boot](https://spring.io/projects/spring-boot) with [Quarkus](https://quarkus.io/)
|
|
23
|
+
|
|
24
|
+
#### Scripting & Automation
|
|
25
|
+
|
|
26
|
+
**YOU MUST** use Deno for all scripting tasks instead of Bash or Python:
|
|
27
|
+
|
|
28
|
+
- Create `deno.json` in project root with tasks for common operations
|
|
29
|
+
- Use JSR imports: `import { walk } from "@std/fs";` NOT `https://deno.land/...`
|
|
30
|
+
- Use [Dax](https://github.com/dsherret/dax) for cross-platform shell operations
|
|
31
|
+
- Example deno.json imports: `"@std/fs": "jsr:@std/fs@^1.0.17"`
|
|
32
|
+
|
|
33
|
+
#### Web Development
|
|
34
|
+
|
|
35
|
+
Use [Deno Fresh](https://fresh.deno.dev/) with these practices:
|
|
36
|
+
|
|
37
|
+
- Built-in test runner: `Deno.test()`
|
|
38
|
+
- Organize tests: `/tests/unit/`, `/tests/component/`, `/tests/e2e/`
|
|
39
|
+
- Mock external dependencies for fast, reliable tests
|
|
40
|
+
- Use fresh-testing-library for component/handler testing
|
|
41
|
+
|
|
42
|
+
## Infrastructure Choices
|
|
43
|
+
|
|
44
|
+
IMPORTANT: I run a Talos Linux Kubernetes Cluster. Use these modern alternatives:
|
|
45
|
+
|
|
46
|
+
- **Database**: Postgres (NOT MySQL)
|
|
47
|
+
- **Cache**: DragonflyDB (NOT Redis)
|
|
48
|
+
- **Streaming**: RedPanda (NOT Kafka)
|
|
49
|
+
- **NoSQL**: ScyllaDB (NOT Cassandra)
|
|
50
|
+
|
|
51
|
+
## Modern Development Tools
|
|
52
|
+
|
|
53
|
+
### Preferred Command-Line Tools
|
|
54
|
+
|
|
55
|
+
**ALWAYS** prefer these modern, fast alternatives:
|
|
56
|
+
|
|
57
|
+
- **ripgrep (rg)**: Use instead of grep for searching code
|
|
58
|
+
- **fd**: Use instead of find for finding files
|
|
59
|
+
- **fzf**: Use for interactive fuzzy finding
|
|
60
|
+
- **bat**: Use instead of cat for syntax-highlighted file viewing
|
|
61
|
+
- **exa/eza**: Use instead of ls for better file listings
|
|
62
|
+
- **delta**: Use for better git diffs
|
|
63
|
+
- **zoxide**: Use instead of cd for smarter directory navigation
|
|
64
|
+
- **duf**: Use instead of df for disk usage
|
|
65
|
+
- **htop/btop**: Use instead of top for process monitoring
|
|
66
|
+
- **jq**: Use for JSON processing and manipulation
|
|
67
|
+
- **yq**: Use for YAML processing and manipulation
|
|
68
|
+
- **hexyl**: Use for hex viewing of binary files
|
|
69
|
+
|
|
70
|
+
### Output Format Preferences
|
|
71
|
+
|
|
72
|
+
**ALWAYS** prefer JSON output for parsing when available:
|
|
73
|
+
|
|
74
|
+
- Use `-o json` or `--json` flags when available (e.g., `kubectl get nodes -o json`)
|
|
75
|
+
- Parse structured JSON output instead of text formats for reliability
|
|
76
|
+
- Use `jq` for JSON processing in scripts
|
|
77
|
+
- Examples:
|
|
78
|
+
- `kubectl get pods -o json | jq '.items[].metadata.name'`
|
|
79
|
+
- `docker inspect container-name | jq '.[0].State.Status'`
|
|
80
|
+
- `aws ec2 describe-instances --output json | jq '.Reservations[].Instances[]'`
|
|
81
|
+
|
|
82
|
+
### Common Commands
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
# Modern tool usage
|
|
86
|
+
rg "pattern" --type rust # Search Rust files
|
|
87
|
+
fd ".rs$" src/ # Find all Rust files
|
|
88
|
+
bat src/main.rs # View file with syntax highlighting
|
|
89
|
+
eza -la --git # List files with git status
|
|
90
|
+
delta # Better git diff viewer
|
|
91
|
+
|
|
92
|
+
# Deno development
|
|
93
|
+
deno task dev # Start development server
|
|
94
|
+
deno task test # Run all tests
|
|
95
|
+
deno test --filter="specific test" # Run single test
|
|
96
|
+
deno task build # Build project
|
|
97
|
+
deno check # Type check
|
|
98
|
+
deno fmt # Format code
|
|
99
|
+
deno lint # Lint code
|
|
100
|
+
|
|
101
|
+
# Project setup
|
|
102
|
+
deno task init # Initialize / configure the project for a new environment
|
|
103
|
+
deno task deps # Update dependencies
|
|
104
|
+
|
|
105
|
+
# Git worktree (for multi-agent workflows)
|
|
106
|
+
git worktree add ../project-feature feature-branch
|
|
107
|
+
git worktree list
|
|
108
|
+
git worktree remove ../project-feature
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## Development Workflow
|
|
112
|
+
|
|
113
|
+
1. **ALWAYS** run type checking/linting after code changes (e.g., `deno check`, `go vet`, `cargo check`)
|
|
114
|
+
2. **ALWAYS** format code before committing using project's formatter
|
|
115
|
+
3. **ALWAYS** run relevant tests before pushing changes
|
|
116
|
+
4. **NEVER** commit without running pre-commit checks
|
|
117
|
+
5. **ALWAYS** use semantic commit messages (feat:, fix:, docs:, refactor:, test:, chore:)
|
|
118
|
+
|
|
119
|
+
### AI-Assisted Development Pattern
|
|
120
|
+
|
|
121
|
+
1. **WRITE** failing tests first (test-driven development)
|
|
122
|
+
2. **GENERATE** implementation with AI assistance
|
|
123
|
+
3. **VERIFY** code meets requirements and security standards
|
|
124
|
+
4. **REFACTOR** at appropriate checkpoints, not continuously
|
|
125
|
+
5. **LOG** extensively for debugging AI-generated code
|
|
126
|
+
|
|
127
|
+
### Context Management
|
|
128
|
+
|
|
129
|
+
- **PROVIDE** clear, specific requirements to minimize context gaps
|
|
130
|
+
- **INCLUDE** relevant project context in prompts
|
|
131
|
+
- **DOCUMENT** assumptions and decisions in code comments
|
|
132
|
+
|
|
133
|
+
## Security & Code Verification
|
|
134
|
+
|
|
135
|
+
### AI-Generated Code Review
|
|
136
|
+
|
|
137
|
+
- **ALWAYS** review and understand AI-generated code before accepting
|
|
138
|
+
- **NEVER** commit code you don't fully understand
|
|
139
|
+
- **RUN** security scanning on all generated code
|
|
140
|
+
- **VERIFY** all third-party dependencies suggested by AI
|
|
141
|
+
- **TEST** edge cases and error handling thoroughly
|
|
142
|
+
|
|
143
|
+
### Sensitive Data Protection
|
|
144
|
+
|
|
145
|
+
- **NEVER** share API keys, credentials, or proprietary code with AI
|
|
146
|
+
- **USE** environment variables or secret management tools
|
|
147
|
+
- **SANITIZE** logs and debug output before sharing
|
|
148
|
+
|
|
149
|
+
## Project Planning & Coordination
|
|
150
|
+
|
|
151
|
+
### PLAN.md Adherence
|
|
152
|
+
|
|
153
|
+
When a `PLAN.md` file exists in the project root, **YOU MUST**:
|
|
154
|
+
|
|
155
|
+
1. **READ** the PLAN.md file at the start of each session to understand current tasks and priorities
|
|
156
|
+
2. **FOLLOW** the task breakdown and execution strategy defined in the plan
|
|
157
|
+
3. **RESPECT** task dependencies and join points for multi-agent coordination
|
|
158
|
+
4. **UPDATE** task status in the plan as work progresses
|
|
159
|
+
5. **COORDINATE** with other agents at defined synchronization points
|
|
160
|
+
6. **USE** the TodoWrite tool to track individual tasks from the plan
|
|
161
|
+
|
|
162
|
+
### Multi-Agent Workflow
|
|
163
|
+
|
|
164
|
+
When working as part of a multi-agent team:
|
|
165
|
+
|
|
166
|
+
- **CHECK** `/tmp/{project-name}/project-status.md` or coordination files for shared state
|
|
167
|
+
- **WORK** only on assigned tasks to avoid conflicts
|
|
168
|
+
- **COMMUNICATE** progress through PR comments or status files
|
|
169
|
+
- **WAIT** at join points until all parallel work is complete
|
|
170
|
+
- **MERGE** work carefully following the plan's integration strategy
|
|
171
|
+
- **USE** git worktrees to work on separate branches without conflicts
|
|
172
|
+
- **CREATE** status files in `/tmp/{project-name}/claude-scratch/` for inter-agent communication
|
|
173
|
+
- **COORDINATE** using shared JSON status files for structured updates in project-specific directories
|
|
174
|
+
|
|
175
|
+
## Performance & Optimization
|
|
176
|
+
|
|
177
|
+
### Token Efficiency
|
|
178
|
+
|
|
179
|
+
- **OPTIMIZE** prompts for clarity and brevity
|
|
180
|
+
- **BATCH** related operations in single requests
|
|
181
|
+
- **USE** structured outputs (JSON) for parsing efficiency
|
|
182
|
+
- **CACHE** common patterns and solutions locally
|
|
183
|
+
|
|
184
|
+
### Parallel Development
|
|
185
|
+
|
|
186
|
+
- **USE** Docker containers for isolated AI agent environments
|
|
187
|
+
- **IMPLEMENT** clear synchronization points for multi-agent work
|
|
188
|
+
- **MAINTAIN** shared state files in `/tmp/{project-name}/`
|
|
189
|
+
|
|
190
|
+
## Task Management
|
|
191
|
+
|
|
192
|
+
Use the task management system for tracking work items:
|
|
193
|
+
|
|
194
|
+
- **Location**: Tasks are stored in `/tasks/` directory with `status.json` index
|
|
195
|
+
- **Commands**: Use `/task-create`, `/task-update`, `/task-list`, `/task-show`, `/task-log`, `/task-search`, `/task-archive`
|
|
196
|
+
- **Format**: Tasks are markdown files with structured metadata
|
|
197
|
+
- **Integration**: Active tasks sync with TodoWrite for session tracking
|
|
198
|
+
|
|
199
|
+
## File Organization
|
|
200
|
+
|
|
201
|
+
- `/src/` - Source code
|
|
202
|
+
- `/tests/` - Test files organized by type
|
|
203
|
+
- `/scripts/` - Deno automation scripts
|
|
204
|
+
- `/tasks/` - Task management files (markdown + status.json)
|
|
205
|
+
- `deno.json` - Project configuration and tasks
|
|
206
|
+
- `import_map.json` - Import mappings (if needed)
|
|
207
|
+
|
|
208
|
+
## Documentation Style
|
|
209
|
+
|
|
210
|
+
### README Files
|
|
211
|
+
|
|
212
|
+
**KEEP README FILES CONCISE AND SCANNABLE:**
|
|
213
|
+
|
|
214
|
+
- **Maximum 50 lines** for most projects
|
|
215
|
+
- **No excessive emojis** or decorative elements
|
|
216
|
+
- **Essential sections only**: Purpose, Quick Start, Key Commands
|
|
217
|
+
- **No verbose explanations** - let code and comments speak
|
|
218
|
+
- **Single quick start command** when possible
|
|
219
|
+
- **Brief feature lists** without detailed descriptions
|
|
220
|
+
- **Minimal project structure** - only if complex
|
|
221
|
+
- **Essential links only** - avoid resource dumps
|
|
222
|
+
|
|
223
|
+
**Example concise README:**
|
|
224
|
+
|
|
225
|
+
````markdown
|
|
226
|
+
# Project Name
|
|
227
|
+
|
|
228
|
+
Brief one-line description of what it does.
|
|
229
|
+
|
|
230
|
+
## Quick Start
|
|
231
|
+
|
|
232
|
+
```bash
|
|
233
|
+
deno task init && deno task dev
|
|
234
|
+
```
|
|
235
|
+
````
|
|
236
|
+
|
|
237
|
+
## Key Commands
|
|
238
|
+
|
|
239
|
+
- `deno task test` - Run tests
|
|
240
|
+
- `deno task build` - Build project
|
|
241
|
+
|
|
242
|
+
## Features
|
|
243
|
+
|
|
244
|
+
- Core feature 1
|
|
245
|
+
- Core feature 2
|
|
246
|
+
- Core feature 3
|
|
247
|
+
|
|
248
|
+
```
|
|
249
|
+
**Avoid:**
|
|
250
|
+
- Long feature descriptions
|
|
251
|
+
- Extensive project structure diagrams
|
|
252
|
+
- Multiple installation methods
|
|
253
|
+
- Verbose technical explanations
|
|
254
|
+
- Marketing-style language
|
|
255
|
+
- Detailed configuration options in main README
|
|
256
|
+
|
|
257
|
+
## Claude Code Features
|
|
258
|
+
|
|
259
|
+
### Thinking Modes
|
|
260
|
+
- `think` - Standard mode (4,000 tokens)
|
|
261
|
+
- `think hard` - Enhanced analysis
|
|
262
|
+
- `think harder` - Deep computation
|
|
263
|
+
- `ultrathink` - Maximum analysis (31,999 tokens)
|
|
264
|
+
|
|
265
|
+
### Effective Usage
|
|
266
|
+
- **USE** thinking modes for complex architectural decisions
|
|
267
|
+
- **AVOID** over-thinking simple tasks
|
|
268
|
+
- **BALANCE** computation time with task complexity
|
|
269
|
+
|
|
270
|
+
## IMPORTANT Notes
|
|
271
|
+
|
|
272
|
+
- **YOU MUST** follow these guidelines exactly as written
|
|
273
|
+
- **ALWAYS** ask for clarification if requirements conflict
|
|
274
|
+
- **NEVER** use deprecated patterns or old import styles
|
|
275
|
+
- **ALWAYS** prioritize performance and type safety
|
|
276
|
+
```
|