Skip to content

workflow-cookbook v0.1

Latest
Latest

Choose a tag to compare

View all tags
@RNA4219 RNA4219 released this 14 Oct 07:27
· 868 commits to main since this release
v0.1.0
ad77dd5
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

✨ workflow-cookbook v0.1

QA / Governance-first なOSS用ワークフロー雛形。
アプリケーションコードではなく、設計 → 検収 → 運用をまわす“土台”を提供します。
AIエージェントはこの土台の上で動き、受入条件とガードレールの範囲内で変更を行います。

This repo defines QA/Governance-first workflows (not application code).
AI agents implement changes under these policies with acceptance tests and canary rules.

🧩 内容一覧

  • BLUEPRINT.md：目的 / 非目的 / 成功指標を定義
  • RUNBOOK.md：機械・人間の両方で再現可能な手順
  • EVALUATION.md：受入条件（＝検収基準）
  • TASK.codex.md：AIへ渡すタスク分解・出力仕様
  • CHECKLISTS.md：レビュー手順をタスク化
  • CHANGELOG.md：更新履歴（Release Drafter対応）
  • GUARDRAILS.md：禁止領域・要承認・簡易SLOの宣言
  • HUB.codex.md：AI / ヒト双方の実行エントリ
  • CI構成：
    • リンク腐り検出（lychee）
    • プローズLint（Vale）
    • リリースノート自動整形（Release Drafter）
  • 外形ファイル：CODEOWNERS / SECURITY.md / LICENSE

🚀 v0.1 ハイライト

  • 🔒 ガードレール先行：コードよりも先に「触れてよい範囲」を明示
  • ✅ 検収駆動：EVALUATION.md が単一の合否基準
  • 🧭 人は監督に集中：AIが実装、ヒトが境界と合否を運用
  • 🧩 クローン前提構成：他OSSへコピーして即運用可（HUBとEVAL差し替え）

🧭 使い方（3ステップ）

  1. クローン：新リポジトリにコピー
  2. HUBを置換：プロジェクト名・Intent IDを更新
  3. EVALUATIONを確定：受入条件を記述 → RUNBOOKで実行確認

PRテンプレートの Intent / BLUEPRINT / EVALUATION 3要素を必須入力とすることで、
「読むルール」から「守らせるルール」に変わります。

⚙️ 既知の制約

  • GUARDRAILS の YAML 抜粋は最小構成（禁止・要承認・SLO のみ）
  • Canary の実システム連携は任意（疑似ラベル運用推奨）
  • SLO バッジの自動生成は未実装（v0.2 以降予定）

🛠 今後のロードマップ

v0.2

  • GUARDRAILS の YAML 抜粋を CI で自動パース → PRゲート化
  • インシデント報告テンプレートの標準添付（EVAL / RUNBOOK連結）
  • SLOメトリクスの README 表示（lead time p95 / CFR / MTTR）

v0.3

  • クローン初期化スクリプト（HUB/EVAL/TASK 自動差し替え）
  • Canary失敗疑似テスト（ラベルで Status Check 落とす）

🧾 CHANGELOG 抜粋

v0.1

Added

  • 初期ファイル群（BLUEPRINT / RUNBOOK / EVALUATION / TASK / CHECKLISTS / CHANGELOG / GUARDRAILS / HUB）
  • PR / Issue テンプレートの Intent / Blueprint / Evaluation 型
  • CI：リンク検査・プローズLint・Release Drafter
  • 外形三点：CODEOWNERS / SECURITY.md / LICENSE

Known Issues

  • GUARDRAILS の数値パラメータはプロジェクトごとに調整が必要

📣 一言で伝えるなら

日本語：

「コードより先に品質を定義する」OSSテンプレート。
仕様＝テスト、ガードレール＝境界。
AIは中で動き、人は外から合否を決める。
workflow-cookbook v0.1 リリース。

English (short):

Ship quality first. Policies, acceptance tests, and guardrails before code.
workflow-cookbook v0.1 is out.

🧭 メンテナ向けメモ

  • 新規OSSに流用する際は HUB と EVALUATION を先に差し替え
  • CODEOWNERS に /GUARDRAILS.md と /HUB.codex.md を追加し、
    自身をレビュワーに設定（統治の可視化）
  • PRラベルは type:* と semver:* の2系統を必須運用

Release drafted: 2025-10-14
Maintained by @RNA4219
License: MIT

Assets 2
Loading