@silbaram/artifact-driven-agent 0.1.9 → 0.2.3
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/README.md +296 -25
- package/ai-dev-team/.ada-status.template.json +10 -10
- package/ai-dev-team/README.md +39 -44
- package/ai-dev-team/artifacts/api.md +2 -212
- package/ai-dev-team/artifacts/features/_template/api.md +19 -19
- package/ai-dev-team/artifacts/features/_template/review.md +14 -14
- package/ai-dev-team/artifacts/features/_template/spec.md +28 -28
- package/ai-dev-team/artifacts/features/_template/ui.md +14 -14
- package/ai-dev-team/artifacts/improvement-reports/IMP-0000-template.md +57 -57
- package/ai-dev-team/artifacts/project.md +2 -193
- package/ai-dev-team/artifacts/rfc/RFC-0000-template.md +49 -49
- package/core/artifacts/decision.md +72 -72
- package/core/artifacts/plan.md +187 -187
- package/core/artifacts/project.md +193 -193
- package/core/artifacts/sprints/_template/docs/release-notes.md +37 -37
- package/core/artifacts/sprints/_template/meta.md +54 -54
- package/core/artifacts/sprints/_template/retrospective.md +50 -50
- package/core/artifacts/sprints/_template/review-reports/review-template.md +49 -49
- package/core/artifacts/sprints/_template/tasks/task-template.md +43 -43
- package/core/docs-templates/mkdocs/docs/architecture/overview.md +29 -29
- package/core/docs-templates/mkdocs/docs/changelog.md +36 -36
- package/core/docs-templates/mkdocs/docs/contributing/contributing.md +60 -60
- package/core/docs-templates/mkdocs/docs/getting-started/configuration.md +51 -51
- package/core/docs-templates/mkdocs/docs/getting-started/installation.md +41 -41
- package/core/docs-templates/mkdocs/docs/getting-started/quick-start.md +56 -56
- package/core/docs-templates/mkdocs/docs/guides/api-reference.md +83 -83
- package/core/docs-templates/mkdocs/docs/index.md +32 -32
- package/core/docs-templates/mkdocs/mkdocs.yml +86 -86
- package/core/roles/analyzer.md +265 -265
- package/core/roles/developer.md +6 -1
- package/core/roles/documenter.md +226 -715
- package/core/roles/improver.md +461 -461
- package/core/roles/manager.md +574 -544
- package/core/roles/planner.md +398 -398
- package/core/roles/reviewer.md +294 -294
- package/core/rules/document-priority.md +198 -198
- package/core/rules/escalation.md +172 -172
- package/core/rules/iteration.md +236 -236
- package/core/rules/rfc.md +31 -31
- package/core/rules/rollback.md +218 -218
- package/core/skills/_template/SKILL.md +50 -0
- package/core/skills/clean-code/SKILL.md +177 -0
- package/core/skills/code-review-checklist/SKILL.md +125 -0
- package/core/skills/error-handling/SKILL.md +155 -0
- package/core/skills/talk-game-dot-design/SKILL.md +85 -0
- package/core/skills/talk-game-dot-design/references/asset-specs.md +57 -0
- package/core/skills/talk-game-dot-design/references/review-checklist.md +34 -0
- package/core/skills/task-writing/SKILL.md +166 -0
- package/core/skills/testing-patterns/SKILL.md +140 -0
- package/dist/bin/cli.d.ts +2 -0
- package/dist/bin/cli.js +121 -0
- package/dist/bin/cli.js.map +1 -0
- package/dist/src/commands/config.d.ts +4 -0
- package/dist/src/commands/config.js +427 -0
- package/dist/src/commands/config.js.map +1 -0
- package/dist/src/commands/docs.d.ts +12 -0
- package/dist/src/commands/docs.js +453 -0
- package/dist/src/commands/docs.js.map +1 -0
- package/dist/src/commands/interactive.d.ts +4 -0
- package/dist/src/commands/interactive.js +380 -0
- package/dist/src/commands/interactive.js.map +1 -0
- package/dist/src/commands/logs.d.ts +1 -0
- package/dist/src/commands/logs.js +76 -0
- package/dist/src/commands/logs.js.map +1 -0
- package/dist/src/commands/monitor.d.ts +6 -0
- package/dist/src/commands/monitor.js +216 -0
- package/dist/src/commands/monitor.js.map +1 -0
- package/dist/src/commands/reset.d.ts +4 -0
- package/dist/src/commands/reset.js +57 -0
- package/dist/src/commands/reset.js.map +1 -0
- package/dist/src/commands/run.d.ts +45 -0
- package/dist/src/commands/run.js +421 -0
- package/dist/src/commands/run.js.map +1 -0
- package/dist/src/commands/sessions.d.ts +5 -0
- package/dist/src/commands/sessions.js +563 -0
- package/dist/src/commands/sessions.js.map +1 -0
- package/dist/src/commands/setup.d.ts +1 -0
- package/dist/src/commands/setup.js +132 -0
- package/dist/src/commands/setup.js.map +1 -0
- package/dist/src/commands/skills.d.ts +4 -0
- package/dist/src/commands/skills.js +748 -0
- package/dist/src/commands/skills.js.map +1 -0
- package/dist/src/commands/sprint.d.ts +4 -0
- package/dist/src/commands/sprint.js +434 -0
- package/dist/src/commands/sprint.js.map +1 -0
- package/dist/src/commands/status.d.ts +1 -0
- package/dist/src/commands/status.js +97 -0
- package/dist/src/commands/status.js.map +1 -0
- package/dist/src/commands/upgrade.d.ts +6 -0
- package/dist/src/commands/upgrade.js +350 -0
- package/dist/src/commands/upgrade.js.map +1 -0
- package/dist/src/commands/validate.d.ts +8 -0
- package/dist/src/commands/validate.js +260 -0
- package/dist/src/commands/validate.js.map +1 -0
- package/dist/src/commands/validate.test.d.ts +1 -0
- package/dist/src/commands/validate.test.js +74 -0
- package/dist/src/commands/validate.test.js.map +1 -0
- package/{src/index.js → dist/src/index.d.ts} +1 -3
- package/dist/src/index.js +15 -0
- package/dist/src/index.js.map +1 -0
- package/dist/src/types/common.d.ts +31 -0
- package/dist/src/types/common.js +2 -0
- package/dist/src/types/common.js.map +1 -0
- package/dist/src/types/config.d.ts +46 -0
- package/dist/src/types/config.js +2 -0
- package/dist/src/types/config.js.map +1 -0
- package/dist/src/types/index.d.ts +53 -0
- package/dist/src/types/index.js +2 -0
- package/dist/src/types/index.js.map +1 -0
- package/dist/src/types/session.d.ts +87 -0
- package/dist/src/types/session.js +2 -0
- package/dist/src/types/session.js.map +1 -0
- package/dist/src/types/task.d.ts +32 -0
- package/dist/src/types/task.js +2 -0
- package/dist/src/types/task.js.map +1 -0
- package/dist/src/ui/dashboard.d.ts +9 -0
- package/dist/src/ui/dashboard.js +468 -0
- package/dist/src/ui/dashboard.js.map +1 -0
- package/dist/src/ui/keyHandler.d.ts +47 -0
- package/dist/src/ui/keyHandler.js +132 -0
- package/dist/src/ui/keyHandler.js.map +1 -0
- package/dist/src/ui/quickActions.d.ts +25 -0
- package/dist/src/ui/quickActions.js +106 -0
- package/dist/src/ui/quickActions.js.map +1 -0
- package/dist/src/utils/config.d.ts +33 -0
- package/dist/src/utils/config.js +135 -0
- package/dist/src/utils/config.js.map +1 -0
- package/dist/src/utils/files.d.ts +84 -0
- package/dist/src/utils/files.js +202 -0
- package/dist/src/utils/files.js.map +1 -0
- package/dist/src/utils/promptBuilder.d.ts +39 -0
- package/dist/src/utils/promptBuilder.js +726 -0
- package/dist/src/utils/promptBuilder.js.map +1 -0
- package/dist/src/utils/sessionState.d.ts +83 -0
- package/dist/src/utils/sessionState.js +466 -0
- package/dist/src/utils/sessionState.js.map +1 -0
- package/dist/src/utils/sessionState.process.test.d.ts +1 -0
- package/dist/src/utils/sessionState.process.test.js +93 -0
- package/dist/src/utils/sessionState.process.test.js.map +1 -0
- package/dist/src/utils/sessionState.test.d.ts +1 -0
- package/dist/src/utils/sessionState.test.js +150 -0
- package/dist/src/utils/sessionState.test.js.map +1 -0
- package/dist/src/utils/sprintUtils.d.ts +13 -0
- package/dist/src/utils/sprintUtils.js +129 -0
- package/dist/src/utils/sprintUtils.js.map +1 -0
- package/dist/src/utils/taskParser.d.ts +9 -0
- package/dist/src/utils/taskParser.js +122 -0
- package/dist/src/utils/taskParser.js.map +1 -0
- package/dist/src/utils/taskParser.test.d.ts +1 -0
- package/dist/src/utils/taskParser.test.js +69 -0
- package/dist/src/utils/taskParser.test.js.map +1 -0
- package/package.json +62 -47
- package/templates/cli/artifacts/commands.md +262 -262
- package/templates/cli/artifacts/output-format.md +298 -298
- package/templates/cli/rules/command-change.md +225 -225
- package/templates/game/artifacts/assets.md +148 -148
- package/templates/game/artifacts/game-systems.md +217 -217
- package/templates/game/artifacts/hud.md +199 -199
- package/templates/game/rules/system-change.md +184 -184
- package/templates/library/artifacts/changelog.md +84 -84
- package/templates/library/artifacts/examples.md +157 -157
- package/templates/library/artifacts/public-api.md +197 -197
- package/templates/library/rules/versioning.md +186 -186
- package/templates/web-dev/artifacts/api.md +212 -212
- package/templates/web-dev/artifacts/ui.md +104 -104
- package/templates/web-dev/rules/api-change.md +198 -198
- package/ai-dev-team/.ada-status.json +0 -10
- package/ai-dev-team/.ada-version +0 -6
- package/ai-dev-team/.current-template +0 -1
- package/ai-dev-team/.gitkeep +0 -0
- package/ai-dev-team/.sessions/logs/20260124-014551-00f04724.log +0 -5
- package/ai-dev-team/.sessions/logs/20260124-014623-cb2b1d44.log +0 -5
- package/ai-dev-team/artifacts/.gitkeep +0 -0
- package/ai-dev-team/artifacts/decision.md +0 -72
- package/ai-dev-team/artifacts/plan.md +0 -187
- package/ai-dev-team/artifacts/sprints/_template/docs/release-notes.md +0 -37
- package/ai-dev-team/artifacts/sprints/_template/meta.md +0 -54
- package/ai-dev-team/artifacts/sprints/_template/retrospective.md +0 -50
- package/ai-dev-team/artifacts/sprints/_template/review-reports/review-template.md +0 -49
- package/ai-dev-team/artifacts/sprints/_template/tasks/task-template.md +0 -43
- package/ai-dev-team/artifacts/ui.md +0 -104
- package/ai-dev-team/roles/.gitkeep +0 -0
- package/ai-dev-team/roles/analyzer.md +0 -265
- package/ai-dev-team/roles/developer.md +0 -222
- package/ai-dev-team/roles/documenter.md +0 -715
- package/ai-dev-team/roles/improver.md +0 -461
- package/ai-dev-team/roles/manager.md +0 -544
- package/ai-dev-team/roles/planner.md +0 -398
- package/ai-dev-team/roles/reviewer.md +0 -294
- package/ai-dev-team/rules/.gitkeep +0 -0
- package/ai-dev-team/rules/api-change.md +0 -198
- package/ai-dev-team/rules/document-priority.md +0 -199
- package/ai-dev-team/rules/escalation.md +0 -172
- package/ai-dev-team/rules/iteration.md +0 -236
- package/ai-dev-team/rules/rfc.md +0 -31
- package/ai-dev-team/rules/rollback.md +0 -218
- package/bin/cli.js +0 -127
- package/src/commands/config.js +0 -371
- package/src/commands/docs.js +0 -502
- package/src/commands/interactive.js +0 -392
- package/src/commands/logs.js +0 -81
- package/src/commands/monitor.js +0 -236
- package/src/commands/reset.js +0 -66
- package/src/commands/run.js +0 -739
- package/src/commands/sessions.js +0 -646
- package/src/commands/setup.js +0 -149
- package/src/commands/sprint.js +0 -503
- package/src/commands/status.js +0 -109
- package/src/commands/upgrade.js +0 -416
- package/src/commands/validate.js +0 -289
- package/src/commands/validate.test.js +0 -84
- package/src/ui/dashboard.js +0 -518
- package/src/ui/keyHandler.js +0 -147
- package/src/ui/quickActions.js +0 -111
- package/src/utils/config.js +0 -74
- package/src/utils/files.js +0 -201
- package/src/utils/sessionState.js +0 -513
- package/src/utils/sessionState.process.test.js +0 -101
- package/src/utils/sessionState.test.js +0 -183
- package/src/utils/sprintUtils.js +0 -134
- package/src/utils/taskParser.js +0 -134
- package/src/utils/taskParser.test.js +0 -76
|
@@ -1,49 +1,49 @@
|
|
|
1
|
-
# Review Report: task-NNN
|
|
2
|
-
|
|
3
|
-
## Task 정보
|
|
4
|
-
- Task: task-NNN [Task 이름]
|
|
5
|
-
- Reviewer: reviewer
|
|
6
|
-
- Review Date: YYYY-MM-DD
|
|
7
|
-
|
|
8
|
-
## 수용 조건 체크
|
|
9
|
-
|
|
10
|
-
- [x] 조건 1 - 충족
|
|
11
|
-
- [x] 조건 2 - 충족
|
|
12
|
-
- [ ] 조건 3 - 미충족 (사유: ...)
|
|
13
|
-
|
|
14
|
-
## 기술 품질 체크
|
|
15
|
-
|
|
16
|
-
- [x] project.md 규칙 준수 (있으면)
|
|
17
|
-
- [x] 코드 스타일 준수
|
|
18
|
-
- [x] 테스트 작성 (필요 시)
|
|
19
|
-
- [ ] 문제 항목 (있으면)
|
|
20
|
-
|
|
21
|
-
## 판정: PASS / REJECT / WARN
|
|
22
|
-
|
|
23
|
-
**PASS** - 모든 조건 충족
|
|
24
|
-
|
|
25
|
-
또는
|
|
26
|
-
|
|
27
|
-
**REJECT** - 수용 조건 미충족
|
|
28
|
-
- 사유 1: [구체적 설명]
|
|
29
|
-
- 사유 2: [구체적 설명]
|
|
30
|
-
|
|
31
|
-
또는
|
|
32
|
-
|
|
33
|
-
**WARN** - 개선 권장
|
|
34
|
-
- 경미한 문제: [설명]
|
|
35
|
-
- 개선 제안: [내용]
|
|
36
|
-
|
|
37
|
-
## 코멘트
|
|
38
|
-
|
|
39
|
-
- [리뷰어의 전반적인 의견]
|
|
40
|
-
- [개선 제안 또는 칭찬]
|
|
41
|
-
|
|
42
|
-
## 수정 필요 사항 (REJECT인 경우)
|
|
43
|
-
|
|
44
|
-
1. [구체적 수정 지시]
|
|
45
|
-
2. [구체적 수정 지시]
|
|
46
|
-
|
|
47
|
-
### 참고
|
|
48
|
-
- project.md 섹션 X.X (있으면)
|
|
49
|
-
- 수용 조건 N번
|
|
1
|
+
# Review Report: task-NNN
|
|
2
|
+
|
|
3
|
+
## Task 정보
|
|
4
|
+
- Task: task-NNN [Task 이름]
|
|
5
|
+
- Reviewer: reviewer
|
|
6
|
+
- Review Date: YYYY-MM-DD
|
|
7
|
+
|
|
8
|
+
## 수용 조건 체크
|
|
9
|
+
|
|
10
|
+
- [x] 조건 1 - 충족
|
|
11
|
+
- [x] 조건 2 - 충족
|
|
12
|
+
- [ ] 조건 3 - 미충족 (사유: ...)
|
|
13
|
+
|
|
14
|
+
## 기술 품질 체크
|
|
15
|
+
|
|
16
|
+
- [x] project.md 규칙 준수 (있으면)
|
|
17
|
+
- [x] 코드 스타일 준수
|
|
18
|
+
- [x] 테스트 작성 (필요 시)
|
|
19
|
+
- [ ] 문제 항목 (있으면)
|
|
20
|
+
|
|
21
|
+
## 판정: PASS / REJECT / WARN
|
|
22
|
+
|
|
23
|
+
**PASS** - 모든 조건 충족
|
|
24
|
+
|
|
25
|
+
또는
|
|
26
|
+
|
|
27
|
+
**REJECT** - 수용 조건 미충족
|
|
28
|
+
- 사유 1: [구체적 설명]
|
|
29
|
+
- 사유 2: [구체적 설명]
|
|
30
|
+
|
|
31
|
+
또는
|
|
32
|
+
|
|
33
|
+
**WARN** - 개선 권장
|
|
34
|
+
- 경미한 문제: [설명]
|
|
35
|
+
- 개선 제안: [내용]
|
|
36
|
+
|
|
37
|
+
## 코멘트
|
|
38
|
+
|
|
39
|
+
- [리뷰어의 전반적인 의견]
|
|
40
|
+
- [개선 제안 또는 칭찬]
|
|
41
|
+
|
|
42
|
+
## 수정 필요 사항 (REJECT인 경우)
|
|
43
|
+
|
|
44
|
+
1. [구체적 수정 지시]
|
|
45
|
+
2. [구체적 수정 지시]
|
|
46
|
+
|
|
47
|
+
### 참고
|
|
48
|
+
- project.md 섹션 X.X (있으면)
|
|
49
|
+
- 수용 조건 N번
|
|
@@ -1,43 +1,43 @@
|
|
|
1
|
-
# TASK-NNN: [Task 이름]
|
|
2
|
-
|
|
3
|
-
| 항목 | 값 |
|
|
4
|
-
|------|-----|
|
|
5
|
-
| 상태 | BACKLOG / IN_DEV / DONE / REJECTED |
|
|
6
|
-
| 우선순위 | P0 / P1 / P2 |
|
|
7
|
-
| 크기 | S / M / L |
|
|
8
|
-
| 출처 | F001 (plan.md 기능 ID) |
|
|
9
|
-
| 담당 | - / developer |
|
|
10
|
-
| 의존성 | - 또는 task-NNN |
|
|
11
|
-
|
|
12
|
-
## 수용 조건 (Acceptance Criteria)
|
|
13
|
-
|
|
14
|
-
- [ ] 조건 1
|
|
15
|
-
- [ ] 조건 2
|
|
16
|
-
- [ ] 조건 3
|
|
17
|
-
|
|
18
|
-
## 구현 노트 (Developer 작성)
|
|
19
|
-
|
|
20
|
-
> Developer가 작업하면서 기록
|
|
21
|
-
|
|
22
|
-
- 구현 방식 설명
|
|
23
|
-
- 기술적 결정 사항
|
|
24
|
-
- 알려진 제약사항
|
|
25
|
-
|
|
26
|
-
## 이슈 (있으면)
|
|
27
|
-
|
|
28
|
-
> 작업 중 발견된 문제나 질문
|
|
29
|
-
|
|
30
|
-
### 이슈 제목
|
|
31
|
-
- 상황: [설명]
|
|
32
|
-
- 영향: [영향도]
|
|
33
|
-
- 제안: [해결 방안]
|
|
34
|
-
|
|
35
|
-
→ 사용자 승인 대기 / 해결됨
|
|
36
|
-
|
|
37
|
-
## 변경 이력
|
|
38
|
-
|
|
39
|
-
| 날짜 | 상태 변경 | 작성자 | 비고 |
|
|
40
|
-
|------|----------|--------|------|
|
|
41
|
-
| YYYY-MM-DD | BACKLOG 생성 | planner | 초기 생성 |
|
|
42
|
-
| YYYY-MM-DD | IN_DEV | developer | 작업 시작 |
|
|
43
|
-
| YYYY-MM-DD | DONE | developer | 구현 완료 |
|
|
1
|
+
# TASK-NNN: [Task 이름]
|
|
2
|
+
|
|
3
|
+
| 항목 | 값 |
|
|
4
|
+
|------|-----|
|
|
5
|
+
| 상태 | BACKLOG / IN_DEV / DONE / REJECTED |
|
|
6
|
+
| 우선순위 | P0 / P1 / P2 |
|
|
7
|
+
| 크기 | S / M / L |
|
|
8
|
+
| 출처 | F001 (plan.md 기능 ID) |
|
|
9
|
+
| 담당 | - / developer |
|
|
10
|
+
| 의존성 | - 또는 task-NNN |
|
|
11
|
+
|
|
12
|
+
## 수용 조건 (Acceptance Criteria)
|
|
13
|
+
|
|
14
|
+
- [ ] 조건 1
|
|
15
|
+
- [ ] 조건 2
|
|
16
|
+
- [ ] 조건 3
|
|
17
|
+
|
|
18
|
+
## 구현 노트 (Developer 작성)
|
|
19
|
+
|
|
20
|
+
> Developer가 작업하면서 기록
|
|
21
|
+
|
|
22
|
+
- 구현 방식 설명
|
|
23
|
+
- 기술적 결정 사항
|
|
24
|
+
- 알려진 제약사항
|
|
25
|
+
|
|
26
|
+
## 이슈 (있으면)
|
|
27
|
+
|
|
28
|
+
> 작업 중 발견된 문제나 질문
|
|
29
|
+
|
|
30
|
+
### 이슈 제목
|
|
31
|
+
- 상황: [설명]
|
|
32
|
+
- 영향: [영향도]
|
|
33
|
+
- 제안: [해결 방안]
|
|
34
|
+
|
|
35
|
+
→ 사용자 승인 대기 / 해결됨
|
|
36
|
+
|
|
37
|
+
## 변경 이력
|
|
38
|
+
|
|
39
|
+
| 날짜 | 상태 변경 | 작성자 | 비고 |
|
|
40
|
+
|------|----------|--------|------|
|
|
41
|
+
| YYYY-MM-DD | BACKLOG 생성 | planner | 초기 생성 |
|
|
42
|
+
| YYYY-MM-DD | IN_DEV | developer | 작업 시작 |
|
|
43
|
+
| YYYY-MM-DD | DONE | developer | 구현 완료 |
|
|
@@ -1,29 +1,29 @@
|
|
|
1
|
-
# 아키텍처 개요
|
|
2
|
-
|
|
3
|
-
## 시스템 아키텍처
|
|
4
|
-
|
|
5
|
-
[고수준 아키텍처 다이어그램 및 설명]
|
|
6
|
-
|
|
7
|
-
## 구성 요소
|
|
8
|
-
|
|
9
|
-
### 구성 요소 1
|
|
10
|
-
**목적:** [설명]
|
|
11
|
-
**책임:**
|
|
12
|
-
- 책임 1
|
|
13
|
-
- 책임 2
|
|
14
|
-
|
|
15
|
-
### 구성 요소 2
|
|
16
|
-
**목적:** [설명]
|
|
17
|
-
**책임:**
|
|
18
|
-
- 책임 1
|
|
19
|
-
- 책임 2
|
|
20
|
-
|
|
21
|
-
## 데이터 흐름
|
|
22
|
-
|
|
23
|
-
```
|
|
24
|
-
사용자 → 프론트엔드 → API → 백엔드 → 데이터베이스
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
## 기술 스택
|
|
28
|
-
|
|
29
|
-
자세한 정보는 [기술 스택](tech-stack.md)을 참고하세요.
|
|
1
|
+
# 아키텍처 개요
|
|
2
|
+
|
|
3
|
+
## 시스템 아키텍처
|
|
4
|
+
|
|
5
|
+
[고수준 아키텍처 다이어그램 및 설명]
|
|
6
|
+
|
|
7
|
+
## 구성 요소
|
|
8
|
+
|
|
9
|
+
### 구성 요소 1
|
|
10
|
+
**목적:** [설명]
|
|
11
|
+
**책임:**
|
|
12
|
+
- 책임 1
|
|
13
|
+
- 책임 2
|
|
14
|
+
|
|
15
|
+
### 구성 요소 2
|
|
16
|
+
**목적:** [설명]
|
|
17
|
+
**책임:**
|
|
18
|
+
- 책임 1
|
|
19
|
+
- 책임 2
|
|
20
|
+
|
|
21
|
+
## 데이터 흐름
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
사용자 → 프론트엔드 → API → 백엔드 → 데이터베이스
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## 기술 스택
|
|
28
|
+
|
|
29
|
+
자세한 정보는 [기술 스택](tech-stack.md)을 참고하세요.
|
|
@@ -1,36 +1,36 @@
|
|
|
1
|
-
# 변경 이력
|
|
2
|
-
|
|
3
|
-
이 프로젝트의 모든 주목할 만한 변경사항이 이 파일에 문서화됩니다.
|
|
4
|
-
|
|
5
|
-
형식은 [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)를 기반으로 하며,
|
|
6
|
-
이 프로젝트는 [Semantic Versioning](https://semver.org/spec/v2.0.0.html)을 따릅니다.
|
|
7
|
-
|
|
8
|
-
## [Unreleased]
|
|
9
|
-
|
|
10
|
-
### Added (추가)
|
|
11
|
-
- 개발 중인 새로운 기능
|
|
12
|
-
|
|
13
|
-
### Changed (변경)
|
|
14
|
-
- 기존 기능의 변경사항
|
|
15
|
-
|
|
16
|
-
### Deprecated (중단 예정)
|
|
17
|
-
- 곧 제거될 예정인 기능
|
|
18
|
-
|
|
19
|
-
### Removed (제거)
|
|
20
|
-
- 제거된 기능
|
|
21
|
-
|
|
22
|
-
### Fixed (수정)
|
|
23
|
-
- 버그 수정
|
|
24
|
-
|
|
25
|
-
### Security (보안)
|
|
26
|
-
- 보안 업데이트
|
|
27
|
-
|
|
28
|
-
## [1.0.0] - YYYY-MM-DD
|
|
29
|
-
|
|
30
|
-
### Added (추가)
|
|
31
|
-
- 최초 릴리스
|
|
32
|
-
- 기능 1
|
|
33
|
-
- 기능 2
|
|
34
|
-
|
|
35
|
-
[Unreleased]: https://github.com/username/repo/compare/v1.0.0...HEAD
|
|
36
|
-
[1.0.0]: https://github.com/username/repo/releases/tag/v1.0.0
|
|
1
|
+
# 변경 이력
|
|
2
|
+
|
|
3
|
+
이 프로젝트의 모든 주목할 만한 변경사항이 이 파일에 문서화됩니다.
|
|
4
|
+
|
|
5
|
+
형식은 [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)를 기반으로 하며,
|
|
6
|
+
이 프로젝트는 [Semantic Versioning](https://semver.org/spec/v2.0.0.html)을 따릅니다.
|
|
7
|
+
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
### Added (추가)
|
|
11
|
+
- 개발 중인 새로운 기능
|
|
12
|
+
|
|
13
|
+
### Changed (변경)
|
|
14
|
+
- 기존 기능의 변경사항
|
|
15
|
+
|
|
16
|
+
### Deprecated (중단 예정)
|
|
17
|
+
- 곧 제거될 예정인 기능
|
|
18
|
+
|
|
19
|
+
### Removed (제거)
|
|
20
|
+
- 제거된 기능
|
|
21
|
+
|
|
22
|
+
### Fixed (수정)
|
|
23
|
+
- 버그 수정
|
|
24
|
+
|
|
25
|
+
### Security (보안)
|
|
26
|
+
- 보안 업데이트
|
|
27
|
+
|
|
28
|
+
## [1.0.0] - YYYY-MM-DD
|
|
29
|
+
|
|
30
|
+
### Added (추가)
|
|
31
|
+
- 최초 릴리스
|
|
32
|
+
- 기능 1
|
|
33
|
+
- 기능 2
|
|
34
|
+
|
|
35
|
+
[Unreleased]: https://github.com/username/repo/compare/v1.0.0...HEAD
|
|
36
|
+
[1.0.0]: https://github.com/username/repo/releases/tag/v1.0.0
|
|
@@ -1,60 +1,60 @@
|
|
|
1
|
-
# 기여 가이드
|
|
2
|
-
|
|
3
|
-
## 기여자 환영!
|
|
4
|
-
|
|
5
|
-
[프로젝트명]에 기여를 고려해주셔서 감사합니다!
|
|
6
|
-
|
|
7
|
-
## 기여 방법
|
|
8
|
-
|
|
9
|
-
### 버그 보고
|
|
10
|
-
|
|
11
|
-
1. [이슈](https://github.com/username/repo/issues)에 이미 보고된 버그인지 확인
|
|
12
|
-
2. 보고되지 않았다면 다음 정보와 함께 새 이슈 생성:
|
|
13
|
-
- 명확한 제목
|
|
14
|
-
- 상세한 설명
|
|
15
|
-
- 재현 단계
|
|
16
|
-
- 예상 동작 vs 실제 동작
|
|
17
|
-
- 환경 정보
|
|
18
|
-
|
|
19
|
-
### 기능 제안
|
|
20
|
-
|
|
21
|
-
1. [토론](https://github.com/username/repo/discussions) 확인
|
|
22
|
-
2. 다음 정보와 함께 새 토론 생성:
|
|
23
|
-
- 기능 설명
|
|
24
|
-
- 사용 사례
|
|
25
|
-
- 제안 구현 (선택 사항)
|
|
26
|
-
|
|
27
|
-
### Pull Request 제출
|
|
28
|
-
|
|
29
|
-
1. 저장소 Fork
|
|
30
|
-
2. 기능 브랜치 생성: `git checkout -b feature/your-feature`
|
|
31
|
-
3. 변경사항 작성
|
|
32
|
-
4. 테스트 작성 또는 업데이트
|
|
33
|
-
5. 테스트 실행: `npm test`
|
|
34
|
-
6. 명확한 메시지로 커밋: `git commit -m "Add feature X"`
|
|
35
|
-
7. Push: `git push origin feature/your-feature`
|
|
36
|
-
8. Pull Request 생성
|
|
37
|
-
|
|
38
|
-
## 개발 환경 설정
|
|
39
|
-
|
|
40
|
-
[개발 가이드](development.md)를 참고하세요.
|
|
41
|
-
|
|
42
|
-
## 코드 스타일
|
|
43
|
-
|
|
44
|
-
- 기존 코드 스타일 준수
|
|
45
|
-
- 린터 실행: `npm run lint`
|
|
46
|
-
- 코드 포맷팅: `npm run format`
|
|
47
|
-
|
|
48
|
-
## 테스트
|
|
49
|
-
|
|
50
|
-
```bash
|
|
51
|
-
# 전체 테스트 실행
|
|
52
|
-
npm test
|
|
53
|
-
|
|
54
|
-
# 특정 테스트 실행
|
|
55
|
-
npm test -- tests/specific.test.js
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
## 행동 강령
|
|
59
|
-
|
|
60
|
-
[행동 강령](code-of-conduct.md)을 참고하세요.
|
|
1
|
+
# 기여 가이드
|
|
2
|
+
|
|
3
|
+
## 기여자 환영!
|
|
4
|
+
|
|
5
|
+
[프로젝트명]에 기여를 고려해주셔서 감사합니다!
|
|
6
|
+
|
|
7
|
+
## 기여 방법
|
|
8
|
+
|
|
9
|
+
### 버그 보고
|
|
10
|
+
|
|
11
|
+
1. [이슈](https://github.com/username/repo/issues)에 이미 보고된 버그인지 확인
|
|
12
|
+
2. 보고되지 않았다면 다음 정보와 함께 새 이슈 생성:
|
|
13
|
+
- 명확한 제목
|
|
14
|
+
- 상세한 설명
|
|
15
|
+
- 재현 단계
|
|
16
|
+
- 예상 동작 vs 실제 동작
|
|
17
|
+
- 환경 정보
|
|
18
|
+
|
|
19
|
+
### 기능 제안
|
|
20
|
+
|
|
21
|
+
1. [토론](https://github.com/username/repo/discussions) 확인
|
|
22
|
+
2. 다음 정보와 함께 새 토론 생성:
|
|
23
|
+
- 기능 설명
|
|
24
|
+
- 사용 사례
|
|
25
|
+
- 제안 구현 (선택 사항)
|
|
26
|
+
|
|
27
|
+
### Pull Request 제출
|
|
28
|
+
|
|
29
|
+
1. 저장소 Fork
|
|
30
|
+
2. 기능 브랜치 생성: `git checkout -b feature/your-feature`
|
|
31
|
+
3. 변경사항 작성
|
|
32
|
+
4. 테스트 작성 또는 업데이트
|
|
33
|
+
5. 테스트 실행: `npm test`
|
|
34
|
+
6. 명확한 메시지로 커밋: `git commit -m "Add feature X"`
|
|
35
|
+
7. Push: `git push origin feature/your-feature`
|
|
36
|
+
8. Pull Request 생성
|
|
37
|
+
|
|
38
|
+
## 개발 환경 설정
|
|
39
|
+
|
|
40
|
+
[개발 가이드](development.md)를 참고하세요.
|
|
41
|
+
|
|
42
|
+
## 코드 스타일
|
|
43
|
+
|
|
44
|
+
- 기존 코드 스타일 준수
|
|
45
|
+
- 린터 실행: `npm run lint`
|
|
46
|
+
- 코드 포맷팅: `npm run format`
|
|
47
|
+
|
|
48
|
+
## 테스트
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
# 전체 테스트 실행
|
|
52
|
+
npm test
|
|
53
|
+
|
|
54
|
+
# 특정 테스트 실행
|
|
55
|
+
npm test -- tests/specific.test.js
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## 행동 강령
|
|
59
|
+
|
|
60
|
+
[행동 강령](code-of-conduct.md)을 참고하세요.
|
|
@@ -1,51 +1,51 @@
|
|
|
1
|
-
# 설정
|
|
2
|
-
|
|
3
|
-
## 설정 파일
|
|
4
|
-
|
|
5
|
-
설정 파일은 일반적으로 `config.yml` 또는 `.configrc`에 위치합니다.
|
|
6
|
-
|
|
7
|
-
```yaml
|
|
8
|
-
# 설정 예시
|
|
9
|
-
option1: value1
|
|
10
|
-
option2: value2
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## 설정 옵션
|
|
14
|
-
|
|
15
|
-
### 기본 옵션
|
|
16
|
-
|
|
17
|
-
| 옵션 | 타입 | 기본값 | 설명 |
|
|
18
|
-
|------|------|--------|------|
|
|
19
|
-
| `option1` | string | `"default"` | 설명 |
|
|
20
|
-
| `option2` | number | `0` | 설명 |
|
|
21
|
-
|
|
22
|
-
### 고급 옵션
|
|
23
|
-
|
|
24
|
-
| 옵션 | 타입 | 기본값 | 설명 |
|
|
25
|
-
|------|------|--------|------|
|
|
26
|
-
| `advanced1` | boolean | `false` | 설명 |
|
|
27
|
-
| `advanced2` | array | `[]` | 설명 |
|
|
28
|
-
|
|
29
|
-
## 환경 변수
|
|
30
|
-
|
|
31
|
-
| 변수 | 설명 | 기본값 |
|
|
32
|
-
|------|------|--------|
|
|
33
|
-
| `ENV_VAR_1` | 설명 | - |
|
|
34
|
-
| `ENV_VAR_2` | 설명 | - |
|
|
35
|
-
|
|
36
|
-
## 예시
|
|
37
|
-
|
|
38
|
-
### 개발 환경 설정
|
|
39
|
-
|
|
40
|
-
```yaml
|
|
41
|
-
mode: development
|
|
42
|
-
debug: true
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
### 프로덕션 환경 설정
|
|
46
|
-
|
|
47
|
-
```yaml
|
|
48
|
-
mode: production
|
|
49
|
-
debug: false
|
|
50
|
-
optimization: true
|
|
51
|
-
```
|
|
1
|
+
# 설정
|
|
2
|
+
|
|
3
|
+
## 설정 파일
|
|
4
|
+
|
|
5
|
+
설정 파일은 일반적으로 `config.yml` 또는 `.configrc`에 위치합니다.
|
|
6
|
+
|
|
7
|
+
```yaml
|
|
8
|
+
# 설정 예시
|
|
9
|
+
option1: value1
|
|
10
|
+
option2: value2
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## 설정 옵션
|
|
14
|
+
|
|
15
|
+
### 기본 옵션
|
|
16
|
+
|
|
17
|
+
| 옵션 | 타입 | 기본값 | 설명 |
|
|
18
|
+
|------|------|--------|------|
|
|
19
|
+
| `option1` | string | `"default"` | 설명 |
|
|
20
|
+
| `option2` | number | `0` | 설명 |
|
|
21
|
+
|
|
22
|
+
### 고급 옵션
|
|
23
|
+
|
|
24
|
+
| 옵션 | 타입 | 기본값 | 설명 |
|
|
25
|
+
|------|------|--------|------|
|
|
26
|
+
| `advanced1` | boolean | `false` | 설명 |
|
|
27
|
+
| `advanced2` | array | `[]` | 설명 |
|
|
28
|
+
|
|
29
|
+
## 환경 변수
|
|
30
|
+
|
|
31
|
+
| 변수 | 설명 | 기본값 |
|
|
32
|
+
|------|------|--------|
|
|
33
|
+
| `ENV_VAR_1` | 설명 | - |
|
|
34
|
+
| `ENV_VAR_2` | 설명 | - |
|
|
35
|
+
|
|
36
|
+
## 예시
|
|
37
|
+
|
|
38
|
+
### 개발 환경 설정
|
|
39
|
+
|
|
40
|
+
```yaml
|
|
41
|
+
mode: development
|
|
42
|
+
debug: true
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### 프로덕션 환경 설정
|
|
46
|
+
|
|
47
|
+
```yaml
|
|
48
|
+
mode: production
|
|
49
|
+
debug: false
|
|
50
|
+
optimization: true
|
|
51
|
+
```
|
|
@@ -1,41 +1,41 @@
|
|
|
1
|
-
# 설치
|
|
2
|
-
|
|
3
|
-
## 사전 요구사항
|
|
4
|
-
|
|
5
|
-
필요한 의존성 및 환경 설정 목록을 확인하세요.
|
|
6
|
-
|
|
7
|
-
## 설치 방법
|
|
8
|
-
|
|
9
|
-
### npm 사용
|
|
10
|
-
|
|
11
|
-
```bash
|
|
12
|
-
npm install [package-name]
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
### yarn 사용
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
yarn add [package-name]
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
### 소스 코드에서 설치
|
|
22
|
-
|
|
23
|
-
```bash
|
|
24
|
-
git clone https://github.com/username/repo.git
|
|
25
|
-
cd repo
|
|
26
|
-
npm install
|
|
27
|
-
npm run build
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
## 설치 확인
|
|
31
|
-
|
|
32
|
-
설치가 제대로 되었는지 확인하세요:
|
|
33
|
-
|
|
34
|
-
```bash
|
|
35
|
-
[command] --version
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
## 다음 단계
|
|
39
|
-
|
|
40
|
-
- [빠른 시작 가이드](quick-start.md)
|
|
41
|
-
- [설정](configuration.md)
|
|
1
|
+
# 설치
|
|
2
|
+
|
|
3
|
+
## 사전 요구사항
|
|
4
|
+
|
|
5
|
+
필요한 의존성 및 환경 설정 목록을 확인하세요.
|
|
6
|
+
|
|
7
|
+
## 설치 방법
|
|
8
|
+
|
|
9
|
+
### npm 사용
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install [package-name]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
### yarn 사용
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
yarn add [package-name]
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### 소스 코드에서 설치
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
git clone https://github.com/username/repo.git
|
|
25
|
+
cd repo
|
|
26
|
+
npm install
|
|
27
|
+
npm run build
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## 설치 확인
|
|
31
|
+
|
|
32
|
+
설치가 제대로 되었는지 확인하세요:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
[command] --version
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## 다음 단계
|
|
39
|
+
|
|
40
|
+
- [빠른 시작 가이드](quick-start.md)
|
|
41
|
+
- [설정](configuration.md)
|