@ripla/godd-mcp 1.0.0 → 1.0.2-canary.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/README.md +2 -2
- package/dist/godd.cjs +116 -111
- package/dist/godd.js +114 -17
- package/dist/index.js +1 -1
- package/package.json +1 -1
- package/templates/agents/architect.hbs +4 -4
- package/templates/agents/auto-documenter.hbs +4 -4
- package/templates/agents/backend-developer.hbs +3 -3
- package/templates/agents/code-reviewer.hbs +2 -2
- package/templates/agents/database-developer.hbs +4 -4
- package/templates/agents/debug-specialist.hbs +2 -2
- package/templates/agents/environment-setup.hbs +1 -1
- package/templates/agents/frontend-developer.hbs +5 -5
- package/templates/agents/integration-qa.hbs +1 -1
- package/templates/agents/pr-writer.hbs +1 -1
- package/templates/agents/quality-lead.hbs +3 -3
- package/templates/agents/requirements-analyst.hbs +2 -2
- package/templates/agents/security-analyst.hbs +1 -1
- package/templates/agents/ssot-updater.hbs +3 -3
- package/templates/agents/technical-writer.hbs +3 -3
- package/templates/agents/unit-test-engineer.hbs +1 -1
- package/templates/prompts/agent-dev-workflow.hbs +1 -1
- package/templates/prompts/docs-init.hbs +41 -59
- package/templates/prompts/docs-update.hbs +10 -10
- package/templates/prompts/notes-deploy.hbs +2 -1
- package/templates/prompts/pr-create.hbs +2 -2
- package/templates/prompts/push-execute.hbs +2 -2
- package/templates/prompts/push.hbs +1 -1
- package/templates/prompts/requirements-to-business-flow.hbs +1 -1
- package/templates/prompts/specification-to-tickets.hbs +1 -1
- package/templates/prompts/submit.hbs +2 -2
- package/templates/prompts/sync.hbs +1 -1
|
@@ -14,52 +14,49 @@ ripla Notes(テキストノート / テーブルノート / drawio)で閲覧
|
|
|
14
14
|
|
|
15
15
|
```
|
|
16
16
|
docs/
|
|
17
|
-
├── README.md
|
|
17
|
+
├── README.md # docs 全体の入口・構成説明
|
|
18
18
|
├── 001_project/
|
|
19
|
-
│ ├── README.md
|
|
20
|
-
│ ├──
|
|
21
|
-
│ ├── features.csv
|
|
22
|
-
│
|
|
23
|
-
│ └── template_README.md
|
|
19
|
+
│ ├── README.md # プロジェクト概要(背景・目的・プロダクト・システム構成・用語)
|
|
20
|
+
│ ├── pages.csv # 各プロダクトの画面一覧(テーブルノート)と各画面の概要
|
|
21
|
+
│ ├── features.csv # 画面ごとの機能一覧(テーブルノート)と各機能の概要
|
|
22
|
+
│ └── tasks.csv # 開発チームからの質問リストと要件定義チームからの要望一覧
|
|
24
23
|
├── 002_business_flow/
|
|
25
|
-
│ ├── README.md
|
|
26
|
-
│
|
|
24
|
+
│ ├── README.md # ビジネスフロー概要、フォルダ内で整理するビジネスフロー一覧
|
|
25
|
+
│ ├── business_flow_name.template.md # 特定業務のビジネスフローを解説
|
|
26
|
+
│ └── business_flow_name.template.drawio # 特定業務のビジネスフローを図示
|
|
27
27
|
├── 003_requirements/
|
|
28
|
-
│ ├── README.md
|
|
29
|
-
│ ├── requirements
|
|
30
|
-
│
|
|
31
|
-
|
|
32
|
-
│
|
|
33
|
-
|
|
34
|
-
├──
|
|
35
|
-
│
|
|
36
|
-
│
|
|
37
|
-
│ └──
|
|
38
|
-
|
|
39
|
-
│
|
|
40
|
-
|
|
41
|
-
│ ├──
|
|
42
|
-
│ ├──
|
|
43
|
-
│ ├──
|
|
44
|
-
│
|
|
45
|
-
├──
|
|
46
|
-
│
|
|
47
|
-
│
|
|
48
|
-
|
|
49
|
-
│ ├──
|
|
50
|
-
│
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
├──
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
├──
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
│ └── README.md # 設定説明(環境変数・デプロイ設定等)
|
|
61
|
-
└── 012_setup/
|
|
62
|
-
└── README.md # セットアップ・デプロイ手順
|
|
28
|
+
│ ├── README.md # フォルダの説明、フォルダ内で整理するrequirements一覧
|
|
29
|
+
│ ├── requirements.template.md # 概要、背景、ユーザーストーリー、画面要件、機能要件、機能詳細、非機能要件、備考
|
|
30
|
+
│ ├── <Product Name>/ # 管理画面、ユーザー向け画面などプロダクトごとにフォルダ作成
|
|
31
|
+
│ │ └── <feature_name>.md # 機能別の要件定義
|
|
32
|
+
│ └── spec/ # 仕様 SSOT(API仕様、インフラ仕様、言語仕様等)
|
|
33
|
+
├── 004_pages/ # 画面設計
|
|
34
|
+
│ ├── README.md # フォルダの説明
|
|
35
|
+
│ └── app/ # 画面のURLパスを整理するため、Reactの app/ ディレクトリを配置
|
|
36
|
+
│ ├── admin/
|
|
37
|
+
│ │ └── corporations/
|
|
38
|
+
│ │ └── requirements.md # 画面ごとの画面要件を記載
|
|
39
|
+
│ └── users/
|
|
40
|
+
├── 005_architecture/ # 開発をするにあたっての実際の設計(インフラ、DB、API、各機能の設計)
|
|
41
|
+
│ ├── README.md # フォルダの説明
|
|
42
|
+
│ ├── stacks/ # 技術スタック
|
|
43
|
+
│ ├── api/ # APIのSwaggerなど
|
|
44
|
+
│ ├── db/ # DB設計(ER図など)
|
|
45
|
+
│ ├── infra/ # インフラアーキテクチャの設計
|
|
46
|
+
│ └── features/ # 各機能の設計
|
|
47
|
+
│ └── feature.template.md # 機能設計書、データフロー、DB設計などを記載
|
|
48
|
+
├── 006_development_workflow/ # 開発のルールやワークフローなどについて
|
|
49
|
+
│ ├── README.md # フォルダの説明
|
|
50
|
+
│ ├── git.md # Gitルール
|
|
51
|
+
│ └── workflow.md # 開発ワークフロー
|
|
52
|
+
└── 007_guides/ # ガイド集
|
|
53
|
+
├── README.md # フォルダの説明
|
|
54
|
+
├── godd_notes_usage.md # GoDD Notesの利用方法
|
|
55
|
+
├── godd_usage.md # GoDD のコマンド一覧、ツール一覧、利用方法
|
|
56
|
+
├── setup_godd.md # GoDD の始め方
|
|
57
|
+
├── setup_godd_notes.md # GoDD Notesの構築方法
|
|
58
|
+
├── setup_infra.md # インフラのCI/CDの構築ガイド
|
|
59
|
+
└── setup_local_environment.md # ローカル環境構築ガイド
|
|
63
60
|
```
|
|
64
61
|
|
|
65
62
|
## ルール
|
|
@@ -82,26 +79,11 @@ id,type,product,category,subject,detail,created_by,created_at,priority,deadline,
|
|
|
82
79
|
機能ID,機能名,概要,phase,優先度,ステータス
|
|
83
80
|
```
|
|
84
81
|
|
|
85
|
-
###
|
|
82
|
+
### pages.csv
|
|
86
83
|
```
|
|
87
84
|
画面ID,画面名,概要,提供フェーズ,関連機能ID,ステータス
|
|
88
85
|
```
|
|
89
86
|
|
|
90
|
-
### requirements-list.csv
|
|
91
|
-
```
|
|
92
|
-
要件ID,要件名,概要,優先度,ステータス
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
### nfr-list.csv
|
|
96
|
-
```
|
|
97
|
-
NFR-ID,カテゴリ,要件,基準,優先度
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
### page-definitions.csv
|
|
101
|
-
```
|
|
102
|
-
画面ID,画面名,URL,認証要否,概要
|
|
103
|
-
```
|
|
104
|
-
|
|
105
87
|
### tables.csv
|
|
106
88
|
```
|
|
107
89
|
テーブル名,カラム名,型,制約,説明
|
|
@@ -15,10 +15,10 @@ docs/
|
|
|
15
15
|
├── 001_project/ # プロジェクト概要、機能要件、画面要件
|
|
16
16
|
├── 002_business_flow/ # ビジネスフロー
|
|
17
17
|
├── 003_requirements/ # 要件定義
|
|
18
|
-
├──
|
|
19
|
-
├──
|
|
20
|
-
├──
|
|
21
|
-
└──
|
|
18
|
+
├── 004_pages/ # 画面設計
|
|
19
|
+
├── 005_architecture/ # 詳細設計(インフラ/DB/API/機能別)
|
|
20
|
+
├── 006_development_workflow/ # 開発ルール・ワークフロー
|
|
21
|
+
└── 007_guides/ # 利用・構築・運用ガイド
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
## ルール
|
|
@@ -35,12 +35,12 @@ docs/
|
|
|
35
35
|
| コード変更種別 | 影響するセクション |
|
|
36
36
|
|---|---|
|
|
37
37
|
| 新機能追加 | 001 (features.csv), 003 (requirements), 006 (features/) |
|
|
38
|
-
| API 変更 |
|
|
39
|
-
| DB スキーマ変更 |
|
|
40
|
-
| 画面追加/変更 | 001 (
|
|
41
|
-
| インフラ変更 |
|
|
42
|
-
| アーキテクチャ変更 |
|
|
43
|
-
| 開発フロー変更 |
|
|
38
|
+
| API 変更 | 005 (api/), 003 (requirements) |
|
|
39
|
+
| DB スキーマ変更 | 005 (db/) |
|
|
40
|
+
| 画面追加/変更 | 001 (pages.csv), 004 (app/) |
|
|
41
|
+
| インフラ変更 | 005 (infra/) |
|
|
42
|
+
| アーキテクチャ変更 | 005 (architecture.md) |
|
|
43
|
+
| 開発フロー変更 | 006 (workflow.md, git.md) |
|
|
44
44
|
| ビジネスフロー変更 | 002 (business_flow/) |
|
|
45
45
|
|
|
46
46
|
## 出力
|
|
@@ -23,7 +23,7 @@ notes-app (React + Vite) ──proxy──▶ notes-api (FastAPI) ──▶
|
|
|
23
23
|
| ローカルで試す / 開発環境 | `godd notes compose --auto` |
|
|
24
24
|
| 設定をカスタマイズしたい | `godd notes compose --config <path>` |
|
|
25
25
|
| AWS にデプロイ | `godd notes deploy -y` |
|
|
26
|
-
|
|
|
26
|
+
| インフラとアプリ雛形を新規構築 | `godd notes infra` |
|
|
27
27
|
|
|
28
28
|
### A. ローカルデプロイ(最も簡単)
|
|
29
29
|
|
|
@@ -79,6 +79,7 @@ godd notes compose --config notes-config.json
|
|
|
79
79
|
**前提**:
|
|
80
80
|
- AWS CLI でログイン済み(`aws sts get-caller-identity` が成功すること)
|
|
81
81
|
- `godd notes infra` でインフラ構築済み
|
|
82
|
+
- `notes-api/` と `notes-app/` がデプロイ対象ルートに存在すること
|
|
82
83
|
- `.godd-notes-infra.json` が存在すること
|
|
83
84
|
|
|
84
85
|
```bash
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
{{> project-context }}
|
|
12
12
|
|
|
13
13
|
## Purpose
|
|
14
|
-
Create a **Pull Request** on GitHub with a well-structured body following the PR template (`docs/
|
|
14
|
+
Create a **Pull Request** on GitHub with a well-structured body following the PR template (`docs/006_development_workflow/pr.template.md`). The Agent analyzes changes, generates PR content, and creates the PR.
|
|
15
15
|
|
|
16
16
|
## Auto-confirm Mode
|
|
17
17
|
{{#if auto_confirm}}
|
|
@@ -27,7 +27,7 @@ Create a **Pull Request** on GitHub with a well-structured body following the PR
|
|
|
27
27
|
**draft is DISABLED (default)** — Create the PR as a regular (ready for review) PR.
|
|
28
28
|
{{/if}}
|
|
29
29
|
|
|
30
|
-
## PR Template (SSOT: `docs/
|
|
30
|
+
## PR Template (SSOT: `docs/006_development_workflow/pr.template.md`)
|
|
31
31
|
The PR body MUST follow this structure:
|
|
32
32
|
|
|
33
33
|
### TL;DR (3-7 lines)
|
|
@@ -32,7 +32,7 @@ Execute **pre-submission checks** and then **push to remote** (`git push`). The
|
|
|
32
32
|
- **If no unpushed commits**: Report "No commits to push" and exit
|
|
33
33
|
|
|
34
34
|
### Step 2: Pre-submission Checks (Quality Gate)
|
|
35
|
-
1. **Spec reflection**: Check if `docs/
|
|
35
|
+
1. **Spec reflection**: Check if `docs/003_requirements/spec/` needs updates for the changes
|
|
36
36
|
2. **Quality gate**: Run the project's quality gate commands:
|
|
37
37
|
- If available: `pnpm quality-gate` (or equivalent from project config)
|
|
38
38
|
- Fallback: lint + typecheck + test for changed areas
|
|
@@ -47,7 +47,7 @@ Execute **pre-submission checks** and then **push to remote** (`git push`). The
|
|
|
47
47
|
```
|
|
48
48
|
Pre-submission Check Results:
|
|
49
49
|
✅ Quality gate: Passed
|
|
50
|
-
✅ Spec reflection: No updates needed (or: Updated docs/
|
|
50
|
+
✅ Spec reflection: No updates needed (or: Updated docs/003_requirements/spec/xxx.md)
|
|
51
51
|
✅ Secret check: No secrets detected
|
|
52
52
|
✅ Breaking changes: None (or: Migration documented)
|
|
53
53
|
|
|
@@ -15,7 +15,7 @@ Organize everything that needs to be done before push/submission — ensuring no
|
|
|
15
15
|
|
|
16
16
|
## Output (Checklist)
|
|
17
17
|
- Local verification (required commands/results)
|
|
18
|
-
- Spec (`docs/
|
|
18
|
+
- Spec (`docs/003_requirements/spec`) reflection status
|
|
19
19
|
- Template (impact analysis/test plan/PR body) creation status
|
|
20
20
|
- Documentation of breaking changes/migration/rollback
|
|
21
21
|
- Secret information leakage check (logs/config/screenshots/etc.)
|
|
@@ -26,4 +26,4 @@ Transform requirements (natural language) into business flows (As-Is / To-Be) an
|
|
|
26
26
|
|
|
27
27
|
### Spec Mapping
|
|
28
28
|
- List the required Spec templates (UI/API/DB/Feature/Usecase/Error Codes) and recommend which to create
|
|
29
|
-
- Specs are placed under `docs/
|
|
29
|
+
- Specs are placed under `docs/003_requirements/spec/`
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
{{> project-context }}
|
|
12
12
|
|
|
13
13
|
## Purpose
|
|
14
|
-
Transform Specs (`docs/
|
|
14
|
+
Transform Specs (`docs/003_requirements/spec/`) into an implementable task list.
|
|
15
15
|
|
|
16
16
|
## Input
|
|
17
17
|
- Target Spec (API/UI/DB/Feature/Usecase/Error Codes)
|
|
@@ -43,7 +43,7 @@ Execute the **complete submission workflow**: pre-submission checks → git push
|
|
|
43
43
|
- If remote branch does not exist yet, run `git log --oneline -10` instead
|
|
44
44
|
3. Execute pre-submission checks:
|
|
45
45
|
- **Quality gate**: Run project's quality gate commands
|
|
46
|
-
- **Spec reflection**: Check if `docs/
|
|
46
|
+
- **Spec reflection**: Check if `docs/003_requirements/spec/` needs updates
|
|
47
47
|
- **Secret check**: Scan for potential secrets in committed content
|
|
48
48
|
- **Breaking changes**: Verify migration docs if breaking changes exist
|
|
49
49
|
4. Present check results
|
|
@@ -78,7 +78,7 @@ Execute the **complete submission workflow**: pre-submission checks → git push
|
|
|
78
78
|
- `git diff origin/<base>...HEAD --stat` for change summary
|
|
79
79
|
2. Generate PR content:
|
|
80
80
|
- **Title**: Use user-provided title, or derive from branch name and changes
|
|
81
|
-
- **Body**: Follow PR template (`docs/
|
|
81
|
+
- **Body**: Follow PR template (`docs/006_development_workflow/pr.template.md`) — fill ALL sections
|
|
82
82
|
3. Present PR title and body for review
|
|
83
83
|
|
|
84
84
|
{{#if auto_confirm}}
|
|
@@ -42,7 +42,7 @@ Sync the current working branch with the latest changes from the default branch
|
|
|
42
42
|
1. List conflicted files with `git diff --name-only --diff-filter=U`
|
|
43
43
|
2. Read each conflicted file and identify conflict markers (`<<<<<<<` / `=======` / `>>>>>>>`)
|
|
44
44
|
3. **Resolution policy (priority order)**:
|
|
45
|
-
1. **Keep the SSOT-compliant side**: If one side adheres to SSOT (`docs/
|
|
45
|
+
1. **Keep the SSOT-compliant side**: If one side adheres to SSOT (`docs/003_requirements/spec/`, `.github/agents/user-clone.agent.md`, etc.) and the other diverges, **adopt the compliant side**
|
|
46
46
|
2. **Both SSOT-compliant and integrable**: If both sides comply with SSOT and can be functionally integrated, **integrate both**
|
|
47
47
|
3. **Both compliant but integration difficult / uncertain**: If safe integration is not possible, **ask the user** (never guess)
|
|
48
48
|
4. After resolving all conflicts:
|