@sk8metal/michi-cli 0.5.0 → 0.8.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 +136 -1
- package/README.md +2 -1
- package/dist/scripts/config/config-schema.d.ts +35 -0
- package/dist/scripts/config/config-schema.d.ts.map +1 -1
- package/dist/scripts/config/config-schema.js +56 -0
- package/dist/scripts/config/config-schema.js.map +1 -1
- package/dist/scripts/confluence-sync.d.ts.map +1 -1
- package/dist/scripts/confluence-sync.js +15 -2
- package/dist/scripts/confluence-sync.js.map +1 -1
- package/dist/scripts/github-actions-client.d.ts +79 -0
- package/dist/scripts/github-actions-client.d.ts.map +1 -0
- package/dist/scripts/github-actions-client.js +182 -0
- package/dist/scripts/github-actions-client.js.map +1 -0
- package/dist/scripts/health-check-service.d.ts +46 -0
- package/dist/scripts/health-check-service.d.ts.map +1 -0
- package/dist/scripts/health-check-service.js +114 -0
- package/dist/scripts/health-check-service.js.map +1 -0
- package/dist/scripts/markdown-to-confluence.d.ts.map +1 -1
- package/dist/scripts/markdown-to-confluence.js +25 -3
- package/dist/scripts/markdown-to-confluence.js.map +1 -1
- package/dist/scripts/mermaid-converter.d.ts +24 -0
- package/dist/scripts/mermaid-converter.d.ts.map +1 -0
- package/dist/scripts/mermaid-converter.js +49 -0
- package/dist/scripts/mermaid-converter.js.map +1 -0
- package/dist/scripts/template/multi-repo-renderer.d.ts +67 -0
- package/dist/scripts/template/multi-repo-renderer.d.ts.map +1 -0
- package/dist/scripts/template/multi-repo-renderer.js +123 -0
- package/dist/scripts/template/multi-repo-renderer.js.map +1 -0
- package/dist/scripts/template/renderer.d.ts +4 -0
- package/dist/scripts/template/renderer.d.ts.map +1 -1
- package/dist/scripts/template/renderer.js.map +1 -1
- package/dist/scripts/test-execution-generator.d.ts.map +1 -1
- package/dist/scripts/test-execution-generator.js +94 -11
- package/dist/scripts/test-execution-generator.js.map +1 -1
- package/dist/scripts/test-script-runner.d.ts +33 -0
- package/dist/scripts/test-script-runner.d.ts.map +1 -0
- package/dist/scripts/test-script-runner.js +77 -0
- package/dist/scripts/test-script-runner.js.map +1 -0
- package/dist/scripts/utils/config-loader.d.ts +21 -1
- package/dist/scripts/utils/config-loader.d.ts.map +1 -1
- package/dist/scripts/utils/config-loader.js +149 -3
- package/dist/scripts/utils/config-loader.js.map +1 -1
- package/dist/scripts/utils/multi-repo-validator.d.ts +30 -0
- package/dist/scripts/utils/multi-repo-validator.d.ts.map +1 -0
- package/dist/scripts/utils/multi-repo-validator.js +105 -0
- package/dist/scripts/utils/multi-repo-validator.js.map +1 -0
- package/dist/scripts/utils/spec-archiver.d.ts +38 -0
- package/dist/scripts/utils/spec-archiver.d.ts.map +1 -0
- package/dist/scripts/utils/spec-archiver.js +210 -0
- package/dist/scripts/utils/spec-archiver.js.map +1 -0
- package/dist/scripts/utils/spec-updater.d.ts +4 -0
- package/dist/scripts/utils/spec-updater.d.ts.map +1 -1
- package/dist/scripts/utils/spec-updater.js.map +1 -1
- package/dist/src/cli.d.ts.map +1 -1
- package/dist/src/cli.js +262 -14
- package/dist/src/cli.js.map +1 -1
- package/dist/src/commands/multi-repo-add-repo.d.ts +26 -0
- package/dist/src/commands/multi-repo-add-repo.d.ts.map +1 -0
- package/dist/src/commands/multi-repo-add-repo.js +56 -0
- package/dist/src/commands/multi-repo-add-repo.js.map +1 -0
- package/dist/src/commands/multi-repo-ci-status.d.ts +46 -0
- package/dist/src/commands/multi-repo-ci-status.d.ts.map +1 -0
- package/dist/src/commands/multi-repo-ci-status.js +285 -0
- package/dist/src/commands/multi-repo-ci-status.js.map +1 -0
- package/dist/src/commands/multi-repo-confluence-sync.d.ts +45 -0
- package/dist/src/commands/multi-repo-confluence-sync.d.ts.map +1 -0
- package/dist/src/commands/multi-repo-confluence-sync.js +135 -0
- package/dist/src/commands/multi-repo-confluence-sync.js.map +1 -0
- package/dist/src/commands/multi-repo-init.d.ts +26 -0
- package/dist/src/commands/multi-repo-init.d.ts.map +1 -0
- package/dist/src/commands/multi-repo-init.js +101 -0
- package/dist/src/commands/multi-repo-init.js.map +1 -0
- package/dist/src/commands/multi-repo-list.d.ts +28 -0
- package/dist/src/commands/multi-repo-list.d.ts.map +1 -0
- package/dist/src/commands/multi-repo-list.js +38 -0
- package/dist/src/commands/multi-repo-list.js.map +1 -0
- package/dist/src/commands/multi-repo-test.d.ts +56 -0
- package/dist/src/commands/multi-repo-test.d.ts.map +1 -0
- package/dist/src/commands/multi-repo-test.js +70 -0
- package/dist/src/commands/multi-repo-test.js.map +1 -0
- package/dist/src/commands/setup-existing.d.ts.map +1 -1
- package/dist/src/commands/setup-existing.js +30 -8
- package/dist/src/commands/setup-existing.js.map +1 -1
- package/dist/src/commands/spec-archive.d.ts +17 -0
- package/dist/src/commands/spec-archive.d.ts.map +1 -0
- package/dist/src/commands/spec-archive.js +40 -0
- package/dist/src/commands/spec-archive.js.map +1 -0
- package/dist/src/commands/spec-list.d.ts +15 -0
- package/dist/src/commands/spec-list.d.ts.map +1 -0
- package/dist/src/commands/spec-list.js +55 -0
- package/dist/src/commands/spec-list.js.map +1 -0
- package/docs/user-guide/guides/multi-repo-guide.md +591 -0
- package/docs/user-guide/guides/multi-repo-migration-guide.md +516 -0
- package/docs/user-guide/reference/multi-repo-api.md +771 -0
- package/docs/user-guide/reference/quick-reference.md +22 -37
- package/package.json +1 -4
- package/scripts/__tests__/config-loader-multi-repo.test.ts +342 -0
- package/scripts/__tests__/github-actions-client.test.ts +543 -0
- package/scripts/__tests__/health-check-service.test.ts +142 -0
- package/scripts/__tests__/markdown-to-confluence.test.ts +262 -0
- package/scripts/__tests__/mermaid-converter.test.ts +236 -0
- package/scripts/__tests__/multi-repo-config-schema.test.ts +335 -0
- package/scripts/__tests__/multi-repo-validator.test.ts +524 -0
- package/scripts/__tests__/spec-archiver.test.ts +512 -0
- package/scripts/__tests__/test-script-runner.test.ts +217 -0
- package/scripts/config/config-schema.ts +64 -0
- package/scripts/confluence-sync.ts +16 -2
- package/scripts/github-actions-client.ts +258 -0
- package/scripts/health-check-service.ts +171 -0
- package/scripts/markdown-to-confluence.ts +37 -6
- package/scripts/mermaid-converter.ts +56 -0
- package/scripts/template/__tests__/multi-repo-renderer.test.ts +261 -0
- package/scripts/template/multi-repo-renderer.ts +172 -0
- package/scripts/template/renderer.ts +5 -0
- package/scripts/test-execution-generator.ts +104 -11
- package/scripts/test-script-runner.ts +130 -0
- package/scripts/utils/__tests__/config-validator.test.ts +104 -6
- package/scripts/utils/__tests__/multi-repo-validator.test.ts +335 -0
- package/scripts/utils/config-loader.ts +197 -3
- package/scripts/utils/multi-repo-validator.ts +141 -0
- package/scripts/utils/spec-archiver.ts +260 -0
- package/scripts/utils/spec-updater.ts +4 -0
- package/templates/claude/agents/pr-size-monitor/AGENT.md +330 -0
- package/templates/claude/commands/michi/spec-impl.md +208 -35
- package/templates/claude-agent/agents/doc-reviewer.md +176 -0
- package/templates/claude-agent/rules/doc-review-rules.md +98 -0
- package/templates/claude-agent/rules/doc-review.md +91 -0
- package/templates/multi-repo/docs/ci-status.md +51 -0
- package/templates/multi-repo/docs/release-notes.md +99 -0
- package/templates/multi-repo/overview/architecture.md +102 -0
- package/templates/multi-repo/overview/requirements.md +68 -0
- package/templates/multi-repo/overview/sequence.md +79 -0
- package/templates/multi-repo/steering/multi-repo.md +74 -0
- package/templates/multi-repo/tests/strategy.md +89 -0
- package/dist/scripts/__tests__/create-project.test.d.ts +0 -2
- package/dist/scripts/__tests__/create-project.test.d.ts.map +0 -1
- package/dist/scripts/__tests__/create-project.test.js +0 -243
- package/dist/scripts/__tests__/create-project.test.js.map +0 -1
- package/dist/scripts/__tests__/jira-transitions.test.d.ts +0 -5
- package/dist/scripts/__tests__/jira-transitions.test.d.ts.map +0 -1
- package/dist/scripts/__tests__/jira-transitions.test.js +0 -172
- package/dist/scripts/__tests__/jira-transitions.test.js.map +0 -1
- package/dist/scripts/__tests__/multi-project-estimate.test.d.ts +0 -2
- package/dist/scripts/__tests__/multi-project-estimate.test.d.ts.map +0 -1
- package/dist/scripts/__tests__/multi-project-estimate.test.js +0 -118
- package/dist/scripts/__tests__/multi-project-estimate.test.js.map +0 -1
- package/dist/scripts/__tests__/setup-existing-project.test.d.ts +0 -2
- package/dist/scripts/__tests__/setup-existing-project.test.d.ts.map +0 -1
- package/dist/scripts/__tests__/setup-existing-project.test.js +0 -208
- package/dist/scripts/__tests__/setup-existing-project.test.js.map +0 -1
- package/dist/scripts/__tests__/setup-interactive.test.d.ts +0 -2
- package/dist/scripts/__tests__/setup-interactive.test.d.ts.map +0 -1
- package/dist/scripts/__tests__/setup-interactive.test.js +0 -166
- package/dist/scripts/__tests__/setup-interactive.test.js.map +0 -1
- package/dist/scripts/__tests__/spec-impl-workflow.test.d.ts +0 -5
- package/dist/scripts/__tests__/spec-impl-workflow.test.d.ts.map +0 -1
- package/dist/scripts/__tests__/spec-impl-workflow.test.js +0 -323
- package/dist/scripts/__tests__/spec-impl-workflow.test.js.map +0 -1
- package/dist/scripts/__tests__/spec-loader.test.d.ts +0 -5
- package/dist/scripts/__tests__/spec-loader.test.d.ts.map +0 -1
- package/dist/scripts/__tests__/spec-loader.test.js +0 -153
- package/dist/scripts/__tests__/spec-loader.test.js.map +0 -1
- package/dist/scripts/__tests__/validate-phase.test.d.ts +0 -5
- package/dist/scripts/__tests__/validate-phase.test.d.ts.map +0 -1
- package/dist/scripts/__tests__/validate-phase.test.js +0 -249
- package/dist/scripts/__tests__/validate-phase.test.js.map +0 -1
- package/dist/scripts/constants/__tests__/environments.test.d.ts +0 -2
- package/dist/scripts/constants/__tests__/environments.test.d.ts.map +0 -1
- package/dist/scripts/constants/__tests__/environments.test.js +0 -125
- package/dist/scripts/constants/__tests__/environments.test.js.map +0 -1
- package/dist/scripts/constants/__tests__/languages.test.d.ts +0 -2
- package/dist/scripts/constants/__tests__/languages.test.d.ts.map +0 -1
- package/dist/scripts/constants/__tests__/languages.test.js +0 -82
- package/dist/scripts/constants/__tests__/languages.test.js.map +0 -1
- package/dist/scripts/create-project.d.ts +0 -16
- package/dist/scripts/create-project.d.ts.map +0 -1
- package/dist/scripts/create-project.js +0 -334
- package/dist/scripts/create-project.js.map +0 -1
- package/dist/scripts/list-projects.d.ts +0 -7
- package/dist/scripts/list-projects.d.ts.map +0 -1
- package/dist/scripts/list-projects.js +0 -88
- package/dist/scripts/list-projects.js.map +0 -1
- package/dist/scripts/template/__tests__/renderer.test.d.ts +0 -2
- package/dist/scripts/template/__tests__/renderer.test.d.ts.map +0 -1
- package/dist/scripts/template/__tests__/renderer.test.js +0 -165
- package/dist/scripts/template/__tests__/renderer.test.js.map +0 -1
- package/dist/scripts/utils/__tests__/aidlc-parser.test.d.ts +0 -5
- package/dist/scripts/utils/__tests__/aidlc-parser.test.d.ts.map +0 -1
- package/dist/scripts/utils/__tests__/aidlc-parser.test.js +0 -315
- package/dist/scripts/utils/__tests__/aidlc-parser.test.js.map +0 -1
- package/dist/scripts/utils/__tests__/business-days.test.d.ts +0 -5
- package/dist/scripts/utils/__tests__/business-days.test.d.ts.map +0 -1
- package/dist/scripts/utils/__tests__/business-days.test.js +0 -171
- package/dist/scripts/utils/__tests__/business-days.test.js.map +0 -1
- package/dist/scripts/utils/__tests__/config-loader.test.d.ts +0 -5
- package/dist/scripts/utils/__tests__/config-loader.test.d.ts.map +0 -1
- package/dist/scripts/utils/__tests__/config-loader.test.js +0 -314
- package/dist/scripts/utils/__tests__/config-loader.test.js.map +0 -1
- package/dist/scripts/utils/__tests__/config-validator.test.d.ts +0 -5
- package/dist/scripts/utils/__tests__/config-validator.test.d.ts.map +0 -1
- package/dist/scripts/utils/__tests__/config-validator.test.js +0 -396
- package/dist/scripts/utils/__tests__/config-validator.test.js.map +0 -1
- package/dist/scripts/utils/__tests__/env-config.test.d.ts +0 -5
- package/dist/scripts/utils/__tests__/env-config.test.d.ts.map +0 -1
- package/dist/scripts/utils/__tests__/env-config.test.js +0 -216
- package/dist/scripts/utils/__tests__/env-config.test.js.map +0 -1
- package/dist/scripts/utils/__tests__/feature-name-validator.test.d.ts +0 -5
- package/dist/scripts/utils/__tests__/feature-name-validator.test.d.ts.map +0 -1
- package/dist/scripts/utils/__tests__/feature-name-validator.test.js +0 -106
- package/dist/scripts/utils/__tests__/feature-name-validator.test.js.map +0 -1
- package/dist/scripts/utils/__tests__/jira-issue-type-fetcher.test.d.ts +0 -5
- package/dist/scripts/utils/__tests__/jira-issue-type-fetcher.test.d.ts.map +0 -1
- package/dist/scripts/utils/__tests__/jira-issue-type-fetcher.test.js +0 -202
- package/dist/scripts/utils/__tests__/jira-issue-type-fetcher.test.js.map +0 -1
- package/dist/scripts/utils/__tests__/project-meta.test.d.ts +0 -6
- package/dist/scripts/utils/__tests__/project-meta.test.d.ts.map +0 -1
- package/dist/scripts/utils/__tests__/project-meta.test.js +0 -154
- package/dist/scripts/utils/__tests__/project-meta.test.js.map +0 -1
- package/dist/scripts/utils/__tests__/security-validator.test.d.ts +0 -6
- package/dist/scripts/utils/__tests__/security-validator.test.d.ts.map +0 -1
- package/dist/scripts/utils/__tests__/security-validator.test.js +0 -219
- package/dist/scripts/utils/__tests__/security-validator.test.js.map +0 -1
- package/dist/scripts/utils/__tests__/spec-updater.test.d.ts +0 -5
- package/dist/scripts/utils/__tests__/spec-updater.test.d.ts.map +0 -1
- package/dist/scripts/utils/__tests__/spec-updater.test.js +0 -158
- package/dist/scripts/utils/__tests__/spec-updater.test.js.map +0 -1
- package/dist/scripts/utils/__tests__/tasks-converter.test.d.ts +0 -5
- package/dist/scripts/utils/__tests__/tasks-converter.test.d.ts.map +0 -1
- package/dist/scripts/utils/__tests__/tasks-converter.test.js +0 -500
- package/dist/scripts/utils/__tests__/tasks-converter.test.js.map +0 -1
- package/dist/scripts/utils/__tests__/tasks-format-validator.test.d.ts +0 -5
- package/dist/scripts/utils/__tests__/tasks-format-validator.test.d.ts.map +0 -1
- package/dist/scripts/utils/__tests__/tasks-format-validator.test.js +0 -314
- package/dist/scripts/utils/__tests__/tasks-format-validator.test.js.map +0 -1
- package/dist/scripts/utils/__tests__/test-runner.test.d.ts +0 -5
- package/dist/scripts/utils/__tests__/test-runner.test.d.ts.map +0 -1
- package/dist/scripts/utils/__tests__/test-runner.test.js +0 -64
- package/dist/scripts/utils/__tests__/test-runner.test.js.map +0 -1
- package/dist/src/__tests__/cli.test.d.ts +0 -5
- package/dist/src/__tests__/cli.test.d.ts.map +0 -1
- package/dist/src/__tests__/cli.test.js +0 -58
- package/dist/src/__tests__/cli.test.js.map +0 -1
- package/dist/src/__tests__/integration/internationalization.test.d.ts +0 -8
- package/dist/src/__tests__/integration/internationalization.test.d.ts.map +0 -1
- package/dist/src/__tests__/integration/internationalization.test.js +0 -333
- package/dist/src/__tests__/integration/internationalization.test.js.map +0 -1
- package/dist/src/__tests__/integration/setup/claude-agent.test.d.ts +0 -5
- package/dist/src/__tests__/integration/setup/claude-agent.test.d.ts.map +0 -1
- package/dist/src/__tests__/integration/setup/claude-agent.test.js +0 -122
- package/dist/src/__tests__/integration/setup/claude-agent.test.js.map +0 -1
- package/dist/src/__tests__/integration/setup/claude.test.d.ts +0 -5
- package/dist/src/__tests__/integration/setup/claude.test.d.ts.map +0 -1
- package/dist/src/__tests__/integration/setup/claude.test.js +0 -193
- package/dist/src/__tests__/integration/setup/claude.test.js.map +0 -1
- package/dist/src/__tests__/integration/setup/cursor.test.d.ts +0 -5
- package/dist/src/__tests__/integration/setup/cursor.test.d.ts.map +0 -1
- package/dist/src/__tests__/integration/setup/cursor.test.js +0 -166
- package/dist/src/__tests__/integration/setup/cursor.test.js.map +0 -1
- package/dist/src/__tests__/integration/setup/helpers/fs-assertions.d.ts +0 -32
- package/dist/src/__tests__/integration/setup/helpers/fs-assertions.d.ts.map +0 -1
- package/dist/src/__tests__/integration/setup/helpers/fs-assertions.js +0 -72
- package/dist/src/__tests__/integration/setup/helpers/fs-assertions.js.map +0 -1
- package/dist/src/__tests__/integration/setup/helpers/test-project.d.ts +0 -38
- package/dist/src/__tests__/integration/setup/helpers/test-project.d.ts.map +0 -1
- package/dist/src/__tests__/integration/setup/helpers/test-project.js +0 -83
- package/dist/src/__tests__/integration/setup/helpers/test-project.js.map +0 -1
- package/dist/src/__tests__/integration/setup/init.test.d.ts +0 -5
- package/dist/src/__tests__/integration/setup/init.test.d.ts.map +0 -1
- package/dist/src/__tests__/integration/setup/init.test.js +0 -352
- package/dist/src/__tests__/integration/setup/init.test.js.map +0 -1
- package/dist/src/__tests__/integration/setup/validation.test.d.ts +0 -5
- package/dist/src/__tests__/integration/setup/validation.test.d.ts.map +0 -1
- package/dist/src/__tests__/integration/setup/validation.test.js +0 -301
- package/dist/src/__tests__/integration/setup/validation.test.js.map +0 -1
- package/dist/src/commands/__tests__/init.test.d.ts +0 -5
- package/dist/src/commands/__tests__/init.test.d.ts.map +0 -1
- package/dist/src/commands/__tests__/init.test.js +0 -255
- package/dist/src/commands/__tests__/init.test.js.map +0 -1
- package/dist/src/commands/__tests__/migrate.test.d.ts +0 -5
- package/dist/src/commands/__tests__/migrate.test.d.ts.map +0 -1
- package/dist/src/commands/__tests__/migrate.test.js +0 -216
- package/dist/src/commands/__tests__/migrate.test.js.map +0 -1
- package/scripts/create-project.ts +0 -386
- package/scripts/list-projects.ts +0 -112
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
---
|
|
2
|
+
globs:
|
|
3
|
+
- "**/*.md"
|
|
4
|
+
alwaysApply: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Automatic Document Review
|
|
8
|
+
|
|
9
|
+
このルールは、Markdownドキュメント作成/編集時に自動的に適用され、ドキュメント品質をチェックします。
|
|
10
|
+
|
|
11
|
+
## レビュー基準
|
|
12
|
+
|
|
13
|
+
@.claude/rules/doc-review-rules.md
|
|
14
|
+
|
|
15
|
+
## 実行タイミング
|
|
16
|
+
|
|
17
|
+
以下のタイミングで自動的にドキュメントレビューを実行してください:
|
|
18
|
+
|
|
19
|
+
1. Markdownファイルを新規作成した後
|
|
20
|
+
2. Markdownファイルの編集を完了した後
|
|
21
|
+
3. ユーザーが明示的にレビューを求めた場合
|
|
22
|
+
|
|
23
|
+
## レビュー実行手順
|
|
24
|
+
|
|
25
|
+
1. **ドキュメント種別の判定**
|
|
26
|
+
- ファイル名やパスから、ドキュメントの種類を判定
|
|
27
|
+
- README.md → README
|
|
28
|
+
- requirements.md, design.md, tasks.md → 設計書
|
|
29
|
+
- CHANGELOG.md → 変更履歴
|
|
30
|
+
- docs/api/ 配下 → API仕様
|
|
31
|
+
- その他 → 一般ドキュメント
|
|
32
|
+
|
|
33
|
+
2. **文量チェック**
|
|
34
|
+
- 現在の行数をカウント
|
|
35
|
+
- ドキュメント種別ごとの目安行数と比較
|
|
36
|
+
- 超過/不足を判定
|
|
37
|
+
|
|
38
|
+
3. **禁止パターンチェック**
|
|
39
|
+
- 「〜することができます」の検出
|
|
40
|
+
- 「〜という」「〜のような」の過剰使用検出
|
|
41
|
+
- 過剰な背景説明の検出
|
|
42
|
+
- 重複記載の検出
|
|
43
|
+
|
|
44
|
+
4. **必須セクションチェック**
|
|
45
|
+
- ドキュメント種別ごとの必須セクションを確認
|
|
46
|
+
- 不足セクションをリストアップ
|
|
47
|
+
|
|
48
|
+
5. **結果出力**
|
|
49
|
+
- doc-review-rules.mdで定義された形式で結果を出力
|
|
50
|
+
- ✅/⚠️/❌ で視覚的に分かりやすく表示
|
|
51
|
+
- 具体的な修正提案を含める
|
|
52
|
+
|
|
53
|
+
## 適用除外
|
|
54
|
+
|
|
55
|
+
以下のファイルはレビューをスキップ:
|
|
56
|
+
- `CHANGELOG.md` (自動生成される場合)
|
|
57
|
+
- `node_modules/**/*.md`
|
|
58
|
+
- `.git/**/*.md`
|
|
59
|
+
- `vendor/**/*.md`
|
|
60
|
+
- `.kiro/settings/**/*.md` (テンプレートファイル)
|
|
61
|
+
|
|
62
|
+
## 注意事項
|
|
63
|
+
|
|
64
|
+
- レビュー結果はユーザーへの提案であり、強制ではありません
|
|
65
|
+
- プロジェクト固有のスタイルガイドがある場合、そちらを優先してください
|
|
66
|
+
- 自動レビューで検出できない品質問題もあるため、最終的には人間によるレビューが重要です
|
|
67
|
+
|
|
68
|
+
## 出力例
|
|
69
|
+
|
|
70
|
+
編集完了後、以下のようなレビュー結果を表示してください:
|
|
71
|
+
|
|
72
|
+
```markdown
|
|
73
|
+
## ドキュメントレビュー結果
|
|
74
|
+
|
|
75
|
+
### 📊 文量チェック
|
|
76
|
+
✅ OK (45行、目標: 30-50行)
|
|
77
|
+
|
|
78
|
+
### 🔍 禁止パターンチェック
|
|
79
|
+
⚠️ 冗長表現: 2箇所
|
|
80
|
+
- L12: 「利用することができます」 → 「利用できます」
|
|
81
|
+
- L28: 「という機能」 → 「機能」
|
|
82
|
+
|
|
83
|
+
### ✅ 必須セクションチェック
|
|
84
|
+
✅ すべて揃っています
|
|
85
|
+
- 概要
|
|
86
|
+
- 使い方
|
|
87
|
+
- ライセンス
|
|
88
|
+
|
|
89
|
+
### 🎯 総合評価
|
|
90
|
+
⚠️ 改善推奨 - 冗長表現の修正をお勧めします
|
|
91
|
+
```
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} - CI Status
|
|
2
|
+
|
|
3
|
+
## プロジェクト情報
|
|
4
|
+
|
|
5
|
+
- **プロジェクト名**: {{PROJECT_NAME}}
|
|
6
|
+
- **JIRAキー**: {{JIRA_KEY}}
|
|
7
|
+
- **Confluenceスペース**: {{CONFLUENCE_SPACE}}
|
|
8
|
+
- **最終更新**: {{CREATED_AT}}
|
|
9
|
+
|
|
10
|
+
## CI結果サマリー
|
|
11
|
+
|
|
12
|
+
| リポジトリ名 | ビルドステータス | テストステータス | カバレッジ | 最終実行日時 | 失敗詳細 |
|
|
13
|
+
|------------|---------------|---------------|----------|------------|----------|
|
|
14
|
+
| <!-- リポジトリ名 --> | <!-- ✅/❌/⏳/❓ --> | <!-- ✅/❌/⏳/❓ --> | <!-- XX% --> | <!-- YYYY-MM-DD HH:mm:ss --> | <!-- GitHub URL --> |
|
|
15
|
+
|
|
16
|
+
<!--
|
|
17
|
+
ステータスアイコン:
|
|
18
|
+
- ✅ success: ビルド・テスト成功
|
|
19
|
+
- ❌ failure: ビルド・テスト失敗
|
|
20
|
+
- ⏳ running: 実行中
|
|
21
|
+
- ❓ unknown: 不明・未実行
|
|
22
|
+
|
|
23
|
+
このファイルは `multi-repo:ci-status <project-name>` コマンドで自動更新されます。
|
|
24
|
+
-->
|
|
25
|
+
|
|
26
|
+
## 統計情報
|
|
27
|
+
|
|
28
|
+
- **総リポジトリ数**: 0
|
|
29
|
+
- **成功**: 0
|
|
30
|
+
- **失敗**: 0
|
|
31
|
+
- **実行中**: 0
|
|
32
|
+
- **不明**: 0
|
|
33
|
+
|
|
34
|
+
## 注意事項
|
|
35
|
+
|
|
36
|
+
このドキュメントは自動生成されます。手動で編集しないでください。
|
|
37
|
+
最新のCI結果を取得するには、以下のコマンドを実行してください:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npm run michi multi-repo:ci-status {{PROJECT_NAME}}
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
差分表示オプション:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
npm run michi multi-repo:ci-status {{PROJECT_NAME}} --diff
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## 変更履歴
|
|
50
|
+
|
|
51
|
+
自動生成のため、変更履歴は記録されません。
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} - リリースノート
|
|
2
|
+
|
|
3
|
+
## プロジェクト情報
|
|
4
|
+
|
|
5
|
+
- **プロジェクト名**: {{PROJECT_NAME}}
|
|
6
|
+
- **JIRAキー**: {{JIRA_KEY}}
|
|
7
|
+
- **Confluenceスペース**: {{CONFLUENCE_SPACE}}
|
|
8
|
+
- **作成日時**: {{CREATED_AT}}
|
|
9
|
+
|
|
10
|
+
## リリースノート一覧
|
|
11
|
+
|
|
12
|
+
### バージョン 1.0.0 (YYYY-MM-DD)
|
|
13
|
+
|
|
14
|
+
#### 新機能 (New Features)
|
|
15
|
+
|
|
16
|
+
- <!-- 新機能を記述してください -->
|
|
17
|
+
|
|
18
|
+
#### 改善 (Improvements)
|
|
19
|
+
|
|
20
|
+
- <!-- 改善内容を記述してください -->
|
|
21
|
+
|
|
22
|
+
#### バグ修正 (Bug Fixes)
|
|
23
|
+
|
|
24
|
+
- <!-- バグ修正を記述してください -->
|
|
25
|
+
|
|
26
|
+
#### Breaking Changes
|
|
27
|
+
|
|
28
|
+
- <!-- 破壊的変更を記述してください(ない場合は「なし」) -->
|
|
29
|
+
|
|
30
|
+
#### 既知の問題 (Known Issues)
|
|
31
|
+
|
|
32
|
+
- <!-- 既知の問題を記述してください -->
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## リリースノート作成ガイド
|
|
37
|
+
|
|
38
|
+
### 新機能 (New Features)
|
|
39
|
+
|
|
40
|
+
ユーザーに提供される新しい機能を記述します。
|
|
41
|
+
|
|
42
|
+
**フォーマット例**:
|
|
43
|
+
```
|
|
44
|
+
- [機能名] 簡潔な説明 (関連JIRA: {{JIRA_KEY}}-XXX)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### 改善 (Improvements)
|
|
48
|
+
|
|
49
|
+
既存機能の改善、パフォーマンス向上、UX改善などを記述します。
|
|
50
|
+
|
|
51
|
+
**フォーマット例**:
|
|
52
|
+
```
|
|
53
|
+
- [改善内容] 詳細説明 (関連JIRA: {{JIRA_KEY}}-XXX)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### バグ修正 (Bug Fixes)
|
|
57
|
+
|
|
58
|
+
修正されたバグを記述します。
|
|
59
|
+
|
|
60
|
+
**フォーマット例**:
|
|
61
|
+
```
|
|
62
|
+
- [バグの内容] 修正内容 (関連JIRA: {{JIRA_KEY}}-XXX)
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Breaking Changes
|
|
66
|
+
|
|
67
|
+
既存の動作を変更する破壊的変更を記述します。
|
|
68
|
+
マイグレーション手順を含めてください。
|
|
69
|
+
|
|
70
|
+
**フォーマット例**:
|
|
71
|
+
```
|
|
72
|
+
- [変更内容] 影響範囲とマイグレーション手順 (関連JIRA: {{JIRA_KEY}}-XXX)
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### 既知の問題 (Known Issues)
|
|
76
|
+
|
|
77
|
+
リリース時点で既知の問題を記述します。
|
|
78
|
+
回避策や対応予定を含めてください。
|
|
79
|
+
|
|
80
|
+
**フォーマット例**:
|
|
81
|
+
```
|
|
82
|
+
- [問題の内容] 回避策または対応予定 (関連JIRA: {{JIRA_KEY}}-XXX)
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## Confluence同期
|
|
88
|
+
|
|
89
|
+
このリリースノートをConfluenceに同期するには、以下のコマンドを実行してください:
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
npm run michi multi-repo:sync {{PROJECT_NAME}} --doc release-notes
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## 変更履歴
|
|
96
|
+
|
|
97
|
+
| 日付 | バージョン | 変更内容 | 担当者 |
|
|
98
|
+
|------|-----------|---------|--------|
|
|
99
|
+
| {{CREATED_AT}} | 1.0.0 | 初版作成 | - |
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} - アーキテクチャ設計書
|
|
2
|
+
|
|
3
|
+
## プロジェクト情報
|
|
4
|
+
|
|
5
|
+
- **プロジェクト名**: {{PROJECT_NAME}}
|
|
6
|
+
- **JIRAキー**: {{JIRA_KEY}}
|
|
7
|
+
- **Confluenceスペース**: {{CONFLUENCE_SPACE}}
|
|
8
|
+
- **作成日時**: {{CREATED_AT}}
|
|
9
|
+
|
|
10
|
+
## システム構成図
|
|
11
|
+
|
|
12
|
+
```mermaid
|
|
13
|
+
graph TB
|
|
14
|
+
A[クライアント] --> B[APIゲートウェイ]
|
|
15
|
+
B --> C[バックエンドサービス]
|
|
16
|
+
C --> D[データベース]
|
|
17
|
+
C --> E[外部API]
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
<!-- システム構成図を更新してください -->
|
|
21
|
+
|
|
22
|
+
## アーキテクチャパターン
|
|
23
|
+
|
|
24
|
+
<!-- 採用するアーキテクチャパターンを記述してください -->
|
|
25
|
+
<!-- 例: マイクロサービス、レイヤードアーキテクチャ、ヘキサゴナルアーキテクチャ -->
|
|
26
|
+
|
|
27
|
+
### レイヤー構成
|
|
28
|
+
|
|
29
|
+
<!-- レイヤー構成を記述してください -->
|
|
30
|
+
|
|
31
|
+
## コンポーネント図
|
|
32
|
+
|
|
33
|
+
```mermaid
|
|
34
|
+
graph LR
|
|
35
|
+
subgraph "プレゼンテーション層"
|
|
36
|
+
A[UI Component]
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
subgraph "ビジネスロジック層"
|
|
40
|
+
B[Service Layer]
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
subgraph "データアクセス層"
|
|
44
|
+
C[Repository]
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
A --> B
|
|
48
|
+
B --> C
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
<!-- コンポーネント図を更新してください -->
|
|
52
|
+
|
|
53
|
+
## 技術スタック
|
|
54
|
+
|
|
55
|
+
### フロントエンド
|
|
56
|
+
|
|
57
|
+
<!-- フロントエンド技術スタックを記述してください -->
|
|
58
|
+
|
|
59
|
+
### バックエンド
|
|
60
|
+
|
|
61
|
+
<!-- バックエンド技術スタックを記述してください -->
|
|
62
|
+
|
|
63
|
+
### データベース
|
|
64
|
+
|
|
65
|
+
<!-- データベース技術スタックを記述してください -->
|
|
66
|
+
|
|
67
|
+
### インフラストラクチャ
|
|
68
|
+
|
|
69
|
+
<!-- インフラストラクチャを記述してください -->
|
|
70
|
+
|
|
71
|
+
## データモデル
|
|
72
|
+
|
|
73
|
+
<!-- データモデルを記述してください -->
|
|
74
|
+
|
|
75
|
+
```mermaid
|
|
76
|
+
erDiagram
|
|
77
|
+
USER ||--o{ ORDER : places
|
|
78
|
+
USER {
|
|
79
|
+
string id
|
|
80
|
+
string name
|
|
81
|
+
string email
|
|
82
|
+
}
|
|
83
|
+
ORDER {
|
|
84
|
+
string id
|
|
85
|
+
string userId
|
|
86
|
+
date createdAt
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## セキュリティアーキテクチャ
|
|
91
|
+
|
|
92
|
+
<!-- セキュリティアーキテクチャを記述してください -->
|
|
93
|
+
|
|
94
|
+
## スケーラビリティ設計
|
|
95
|
+
|
|
96
|
+
<!-- スケーラビリティ設計を記述してください -->
|
|
97
|
+
|
|
98
|
+
## 変更履歴
|
|
99
|
+
|
|
100
|
+
| 日付 | バージョン | 変更内容 | 担当者 |
|
|
101
|
+
|------|-----------|---------|--------|
|
|
102
|
+
| {{CREATED_AT}} | 1.0.0 | 初版作成 | - |
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} - 要件定義書
|
|
2
|
+
|
|
3
|
+
## プロジェクト情報
|
|
4
|
+
|
|
5
|
+
- **プロジェクト名**: {{PROJECT_NAME}}
|
|
6
|
+
- **JIRAキー**: {{JIRA_KEY}}
|
|
7
|
+
- **Confluenceスペース**: {{CONFLUENCE_SPACE}}
|
|
8
|
+
- **作成日時**: {{CREATED_AT}}
|
|
9
|
+
|
|
10
|
+
## 概要
|
|
11
|
+
|
|
12
|
+
このドキュメントは、{{PROJECT_NAME}}プロジェクトの要件定義書です。
|
|
13
|
+
|
|
14
|
+
## ビジネス価値
|
|
15
|
+
|
|
16
|
+
<!-- プロジェクトのビジネス価値を記述してください -->
|
|
17
|
+
|
|
18
|
+
### 対象ユーザー
|
|
19
|
+
|
|
20
|
+
<!-- 対象ユーザーを記述してください -->
|
|
21
|
+
- プロジェクトリーダー
|
|
22
|
+
- アーキテクト
|
|
23
|
+
- 開発者
|
|
24
|
+
- QAエンジニア
|
|
25
|
+
|
|
26
|
+
### 主要機能
|
|
27
|
+
|
|
28
|
+
<!-- 主要機能を記述してください -->
|
|
29
|
+
|
|
30
|
+
## 受入基準(EARS形式)
|
|
31
|
+
|
|
32
|
+
### 必須要件
|
|
33
|
+
|
|
34
|
+
<!-- EARS形式(Event-Action-Response-System)で受入基準を記述してください -->
|
|
35
|
+
<!-- 例: -->
|
|
36
|
+
<!-- - WHEN ユーザーがプロジェクトを初期化する際、IF プロジェクト名が有効である場合、THEN システムはプロジェクトディレクトリを作成し、成功メッセージを表示する。 -->
|
|
37
|
+
|
|
38
|
+
### 任意要件
|
|
39
|
+
|
|
40
|
+
<!-- 任意要件を記述してください -->
|
|
41
|
+
|
|
42
|
+
## 技術的制約
|
|
43
|
+
|
|
44
|
+
<!-- 技術的制約を記述してください -->
|
|
45
|
+
|
|
46
|
+
## 非機能要件
|
|
47
|
+
|
|
48
|
+
### パフォーマンス要件
|
|
49
|
+
|
|
50
|
+
<!-- パフォーマンス要件を記述してください -->
|
|
51
|
+
|
|
52
|
+
### セキュリティ要件
|
|
53
|
+
|
|
54
|
+
<!-- セキュリティ要件を記述してください -->
|
|
55
|
+
|
|
56
|
+
### 保守性要件
|
|
57
|
+
|
|
58
|
+
<!-- 保守性要件を記述してください -->
|
|
59
|
+
|
|
60
|
+
## リスクと制限事項
|
|
61
|
+
|
|
62
|
+
<!-- リスクと制限事項を記述してください -->
|
|
63
|
+
|
|
64
|
+
## 変更履歴
|
|
65
|
+
|
|
66
|
+
| 日付 | バージョン | 変更内容 | 担当者 |
|
|
67
|
+
|------|-----------|---------|--------|
|
|
68
|
+
| {{CREATED_AT}} | 1.0.0 | 初版作成 | - |
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} - シーケンス図
|
|
2
|
+
|
|
3
|
+
## プロジェクト情報
|
|
4
|
+
|
|
5
|
+
- **プロジェクト名**: {{PROJECT_NAME}}
|
|
6
|
+
- **JIRAキー**: {{JIRA_KEY}}
|
|
7
|
+
- **Confluenceスペース**: {{CONFLUENCE_SPACE}}
|
|
8
|
+
- **作成日時**: {{CREATED_AT}}
|
|
9
|
+
|
|
10
|
+
## 主要フローのシーケンス図
|
|
11
|
+
|
|
12
|
+
### ユーザー登録フロー
|
|
13
|
+
|
|
14
|
+
```mermaid
|
|
15
|
+
sequenceDiagram
|
|
16
|
+
participant U as ユーザー
|
|
17
|
+
participant F as フロントエンド
|
|
18
|
+
participant B as バックエンド
|
|
19
|
+
participant DB as データベース
|
|
20
|
+
|
|
21
|
+
U->>F: 登録情報を入力
|
|
22
|
+
F->>B: POST /api/users
|
|
23
|
+
B->>DB: ユーザー情報を保存
|
|
24
|
+
DB-->>B: 保存成功
|
|
25
|
+
B-->>F: ユーザーID返却
|
|
26
|
+
F-->>U: 登録完了メッセージ表示
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
<!-- ユーザー登録フローを更新してください -->
|
|
30
|
+
|
|
31
|
+
### データ取得フロー
|
|
32
|
+
|
|
33
|
+
```mermaid
|
|
34
|
+
sequenceDiagram
|
|
35
|
+
participant U as ユーザー
|
|
36
|
+
participant F as フロントエンド
|
|
37
|
+
participant B as バックエンド
|
|
38
|
+
participant DB as データベース
|
|
39
|
+
participant C as キャッシュ
|
|
40
|
+
|
|
41
|
+
U->>F: データリクエスト
|
|
42
|
+
F->>B: GET /api/data
|
|
43
|
+
B->>C: キャッシュ確認
|
|
44
|
+
alt キャッシュヒット
|
|
45
|
+
C-->>B: キャッシュデータ返却
|
|
46
|
+
else キャッシュミス
|
|
47
|
+
B->>DB: データクエリ
|
|
48
|
+
DB-->>B: データ返却
|
|
49
|
+
B->>C: キャッシュ保存
|
|
50
|
+
end
|
|
51
|
+
B-->>F: データ返却
|
|
52
|
+
F-->>U: データ表示
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
<!-- データ取得フローを更新してください -->
|
|
56
|
+
|
|
57
|
+
### エラーハンドリングフロー
|
|
58
|
+
|
|
59
|
+
```mermaid
|
|
60
|
+
sequenceDiagram
|
|
61
|
+
participant U as ユーザー
|
|
62
|
+
participant F as フロントエンド
|
|
63
|
+
participant B as バックエンド
|
|
64
|
+
participant L as ログサービス
|
|
65
|
+
|
|
66
|
+
U->>F: リクエスト送信
|
|
67
|
+
F->>B: API呼び出し
|
|
68
|
+
B-->>F: エラーレスポンス(500)
|
|
69
|
+
F->>L: エラーログ記録
|
|
70
|
+
F-->>U: エラーメッセージ表示
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
<!-- エラーハンドリングフローを更新してください -->
|
|
74
|
+
|
|
75
|
+
## 変更履歴
|
|
76
|
+
|
|
77
|
+
| 日付 | バージョン | 変更内容 | 担当者 |
|
|
78
|
+
|------|-----------|---------|--------|
|
|
79
|
+
| {{CREATED_AT}} | 1.0.0 | 初版作成 | - |
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} - Multi-Repo プロジェクトステアリング
|
|
2
|
+
|
|
3
|
+
## プロジェクト情報
|
|
4
|
+
|
|
5
|
+
- **プロジェクト名**: {{PROJECT_NAME}}
|
|
6
|
+
- **JIRAキー**: {{JIRA_KEY}}
|
|
7
|
+
- **Confluenceスペース**: {{CONFLUENCE_SPACE}}
|
|
8
|
+
- **作成日時**: {{CREATED_AT}}
|
|
9
|
+
|
|
10
|
+
## Multi-Repo 開発ガイドライン
|
|
11
|
+
|
|
12
|
+
### リポジトリ管理方針
|
|
13
|
+
|
|
14
|
+
<!-- リポジトリ管理方針を記述してください -->
|
|
15
|
+
|
|
16
|
+
#### ブランチ戦略
|
|
17
|
+
|
|
18
|
+
- **main/master**: 本番環境相当(常にデプロイ可能な状態)
|
|
19
|
+
- **develop**: 開発環境(次回リリース予定の機能を統合)
|
|
20
|
+
- **feature/**: 機能開発用
|
|
21
|
+
- **bugfix/**: バグ修正用
|
|
22
|
+
- **hotfix/**: 緊急修正用
|
|
23
|
+
|
|
24
|
+
#### コミットメッセージ規約
|
|
25
|
+
|
|
26
|
+
- `feat:` 新機能
|
|
27
|
+
- `fix:` バグ修正
|
|
28
|
+
- `docs:` ドキュメント
|
|
29
|
+
- `style:` フォーマット
|
|
30
|
+
- `refactor:` リファクタリング
|
|
31
|
+
- `test:` テスト
|
|
32
|
+
- `chore:` その他
|
|
33
|
+
|
|
34
|
+
### CI/CD パイプライン
|
|
35
|
+
|
|
36
|
+
#### Phase A: PR作成前の自動テスト
|
|
37
|
+
|
|
38
|
+
- 単体テスト実行
|
|
39
|
+
- Lint実行
|
|
40
|
+
- ビルド実行
|
|
41
|
+
|
|
42
|
+
#### Phase B: リリース準備テスト
|
|
43
|
+
|
|
44
|
+
- 統合テスト実行
|
|
45
|
+
- E2Eテスト実行
|
|
46
|
+
- パフォーマンステスト実行
|
|
47
|
+
- セキュリティテスト実行
|
|
48
|
+
|
|
49
|
+
### コードレビュー基準
|
|
50
|
+
|
|
51
|
+
<!-- コードレビュー基準を記述してください -->
|
|
52
|
+
|
|
53
|
+
### テスト戦略
|
|
54
|
+
|
|
55
|
+
<!-- テスト戦略を記述してください -->
|
|
56
|
+
|
|
57
|
+
### セキュリティポリシー
|
|
58
|
+
|
|
59
|
+
<!-- セキュリティポリシーを記述してください -->
|
|
60
|
+
|
|
61
|
+
### パフォーマンス要件
|
|
62
|
+
|
|
63
|
+
<!-- パフォーマンス要件を記述してください -->
|
|
64
|
+
|
|
65
|
+
## リポジトリ一覧
|
|
66
|
+
|
|
67
|
+
<!-- このプロジェクトに属するリポジトリを記述してください -->
|
|
68
|
+
<!-- multi-repo:add-repo コマンドでリポジトリを追加できます -->
|
|
69
|
+
|
|
70
|
+
## 変更履歴
|
|
71
|
+
|
|
72
|
+
| 日付 | バージョン | 変更内容 | 担当者 |
|
|
73
|
+
|------|-----------|---------|--------|
|
|
74
|
+
| {{CREATED_AT}} | 1.0.0 | 初版作成 | - |
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} - テスト戦略
|
|
2
|
+
|
|
3
|
+
## プロジェクト情報
|
|
4
|
+
|
|
5
|
+
- **プロジェクト名**: {{PROJECT_NAME}}
|
|
6
|
+
- **JIRAキー**: {{JIRA_KEY}}
|
|
7
|
+
- **Confluenceスペース**: {{CONFLUENCE_SPACE}}
|
|
8
|
+
- **作成日時**: {{CREATED_AT}}
|
|
9
|
+
|
|
10
|
+
## テスト戦略概要
|
|
11
|
+
|
|
12
|
+
このドキュメントは、{{PROJECT_NAME}}プロジェクトのテスト戦略を定義します。
|
|
13
|
+
|
|
14
|
+
## テストタイプ
|
|
15
|
+
|
|
16
|
+
### 単体テスト (Unit Test)
|
|
17
|
+
|
|
18
|
+
- **実行タイミング**: PR作成前(Phase A)
|
|
19
|
+
- **カバレッジ目標**: 95%以上
|
|
20
|
+
- **実行コマンド**: `npm test`
|
|
21
|
+
- **テストフレームワーク**: <!-- テストフレームワークを記述 -->
|
|
22
|
+
|
|
23
|
+
### 統合テスト (Integration Test)
|
|
24
|
+
|
|
25
|
+
- **実行タイミング**: リリース準備時(Phase B)
|
|
26
|
+
- **カバレッジ目標**: 主要フローのカバー
|
|
27
|
+
- **実行コマンド**: `npm run test:integration`
|
|
28
|
+
- **テスト対象**: <!-- テスト対象を記述 -->
|
|
29
|
+
|
|
30
|
+
### E2Eテスト (End-to-End Test)
|
|
31
|
+
|
|
32
|
+
- **実行タイミング**: リリース準備時(Phase B)
|
|
33
|
+
- **カバレッジ目標**: クリティカルユーザーフロー
|
|
34
|
+
- **実行コマンド**: `npm run test:e2e`
|
|
35
|
+
- **テストツール**: <!-- テストツールを記述 -->
|
|
36
|
+
|
|
37
|
+
### パフォーマンステスト (Performance Test)
|
|
38
|
+
|
|
39
|
+
- **実行タイミング**: リリース準備時(Phase B)
|
|
40
|
+
- **目標**: <!-- パフォーマンス目標を記述 -->
|
|
41
|
+
- **実行コマンド**: `npm run test:performance`
|
|
42
|
+
- **測定項目**: レスポンスタイム、スループット、リソース使用量
|
|
43
|
+
|
|
44
|
+
### セキュリティテスト (Security Test)
|
|
45
|
+
|
|
46
|
+
- **実行タイミング**: リリース準備時(Phase B)
|
|
47
|
+
- **テスト項目**:
|
|
48
|
+
- パストラバーサル攻撃
|
|
49
|
+
- 制御文字インジェクション
|
|
50
|
+
- コマンドインジェクション
|
|
51
|
+
- SQLインジェクション
|
|
52
|
+
- XSS攻撃
|
|
53
|
+
- **実行コマンド**: `npm run test:security`
|
|
54
|
+
|
|
55
|
+
## Phase A: PR前自動テスト
|
|
56
|
+
|
|
57
|
+
PR作成前に自動実行されるテスト:
|
|
58
|
+
|
|
59
|
+
- [ ] 単体テスト
|
|
60
|
+
- [ ] Lint
|
|
61
|
+
- [ ] 型チェック
|
|
62
|
+
- [ ] ビルド
|
|
63
|
+
|
|
64
|
+
## Phase B: リリース準備テスト
|
|
65
|
+
|
|
66
|
+
リリース前に手動実行するテスト:
|
|
67
|
+
|
|
68
|
+
- [ ] 統合テスト
|
|
69
|
+
- [ ] E2Eテスト
|
|
70
|
+
- [ ] パフォーマンステスト
|
|
71
|
+
- [ ] セキュリティテスト
|
|
72
|
+
|
|
73
|
+
## テストデータ管理
|
|
74
|
+
|
|
75
|
+
<!-- テストデータ管理方針を記述してください -->
|
|
76
|
+
|
|
77
|
+
## テスト環境
|
|
78
|
+
|
|
79
|
+
<!-- テスト環境を記述してください -->
|
|
80
|
+
|
|
81
|
+
## 継続的改善
|
|
82
|
+
|
|
83
|
+
<!-- 継続的改善方針を記述してください -->
|
|
84
|
+
|
|
85
|
+
## 変更履歴
|
|
86
|
+
|
|
87
|
+
| 日付 | バージョン | 変更内容 | 担当者 |
|
|
88
|
+
|------|-----------|---------|--------|
|
|
89
|
+
| {{CREATED_AT}} | 1.0.0 | 初版作成 | - |
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"create-project.test.d.ts","sourceRoot":"","sources":["../../../scripts/__tests__/create-project.test.ts"],"names":[],"mappings":""}
|