Skip to content

luru84/AI-driven-development-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AI-driven Development Starter

AI 駆動(アーティファクト駆動)でプロジェクトを進めるためのテンプレート。agent/work/ で作業の型を提供し、コードスタックは後から選びます(現在は python テンプレを同梱)。


このリポから新規プロジェクトを切る手順

  1. テンプレートからリポを作成
    GitHub の「Use this template」または gh repo create --template ...
  2. クローン
    git clone <your-repo>
  3. スタックを選択して適用
    • 現在の提供スタック: python
    • 適用コマンド: ./scripts/init-stack.sh python
    • 追加スタックは templates/<stack>/ に置き、同じコマンドで適用
  4. AI の作業スペースを使う
    • 役割定義は agent/、作業ログ・生成物は work/ に記録
  5. スタック固有のセットアップ
    • python スタックを適用した場合:
    make setup   # venv 作成 + 依存インストール
    make test    # pytest 実行

プロジェクト構成

.
├─ src/                  # ※スタック適用後に配置されるコード
├─ tests/                # ※スタック適用後に配置されるテスト
├─ docs/                  # 仕様・評価・用語など
│  └─ ARCHITECTURE.md     # 1行アーキ図など
├─ agent/                 # AI エージェント用の状態(planner/implementer/reviewer など)
│  ├─ planner.md          # ゴールとステップ計画
│  ├─ implementer.md      # 実行中ステップと生成物ログ
│  ├─ reviewer.md         # 指摘・質問・判定
│  ├─ decisions.md        # 判断ログ
│  ├─ prompts/            # system/user プロンプト
│  └─ context/            # 調査メモなど
├─ work/                  # 生成物・一時成果物 (テンプレあり、gitignore 済)
│  ├─ goal.md             # 目的とスコープ
│  ├─ plan.md             # ステップ計画
│  ├─ task.md             # 実行中タスクの詳細
│  ├─ log.md              # 実行ログ
│  └─ review.md           # レビュー結果
├─ scripts/init-stack.sh  # スタックをテンプレートから適用するスクリプト
├─ templates/             # 言語/スタック別テンプレ(python 同梱)
├─ .github/workflows/ci.yml  # プレースホルダ CI(スタック適用後に差し替え)
├─ Makefile               # スタック未選択時は no-op(適用後に差し替え)
└─ README.md

Make コマンド

スタック未選択時は no-op です。テンプレ適用後はスタックごとの Makefile が有効になります。

python スタック適用後の例:

コマンド 説明
make setup venv 作成 + 依存インストール
make run yourpkg を起動(__main__.py
make test pytest -q を実行
make fmt black + isort で整形
make lint flake8 で静的解析
make typecheck mypy で型チェック
make clean キャッシュ掃除

AI 駆動での進め方(/agent と /work)

アーティファクト駆動で回すための最低限の作法を同梱しています。

  1. 役割別に記録: 計画は agent/planner.md、実装ログは agent/implementer.md、レビューは agent/reviewer.md
  2. 仕様解釈・スコープ変更は agent/decisions.md に追記
  3. LLM に渡すプロンプトは agent/prompts/ に保存
  4. 作業ノートは work/goal.md, plan.md, task.md, log.md, review.md をベースに回す
  5. 生成物・ログは work/<session>/ 配下に置く(work/ は gitignore 済)

セッション例:

SESSION=work/$(date +%Y%m%d-%H%M)
mkdir -p "$SESSION"/{artifacts,logs}
echo "# Session $SESSION" > "$SESSION/README.md"

状態(plan/decisions/prompts)は常に /agent に集約し、/work は自由に掃除できる一時領域として使うと回しやすいです。

ローカル実行(python スタック適用後の例)

make run
# => hello from yourpkg

テスト(python スタック適用後の例)

make test

開発フロー(例)

0) 事前準備(任意)

brew install gh
gh auth login

1) ブランチ作成

git checkout -b feat/change-sample

2) 変更・実行

make run
make test
make lint
make typecheck

3) コミット

git add -A
git commit -m "feat: short description of the change"

4) push

git push -u origin feat/change-sample

5) PR 作成

ブラウザから「Compare & pull request」 または CLI:

gh pr create --title "feat: short description" \
             --body "変更概要/受け入れ基準/テスト観点/影響範囲"

6) レビュー & CI 確認

  • CI が green かを確認
  • コメントがあれば解消(Resolve)

7) マージ

  • Squash and merge 推奨

8) 後始末(ブランチ削除)

git checkout main
git pull
git branch -d feat/change-sample

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages