From c7389a5b24da00cbd11a9f625dcacbbd5083cec3 Mon Sep 17 00:00:00 2001 From: nrslib <38722970+nrslib@users.noreply.github.com> Date: Sat, 28 Feb 2026 09:48:18 +0900 Subject: [PATCH] docs: add review mode examples to CONTRIBUTING --- CONTRIBUTING.md | 10 +++++++++- docs/CONTRIBUTING.ja.md | 10 +++++++++- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ce46b01..a0f7fc2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,9 +38,17 @@ npm test ### 2. Run TAKT review +The review piece auto-detects the review mode based on the input: + ```bash -# Create your PR first, then run review against it +# PR mode — review a pull request by number takt -t "#" -w review + +# Branch mode — review a branch diff against main +takt -t "" -w review + +# Current diff mode — review uncommitted or recent changes +takt -t "review current changes" -w review ``` ### 3. Confirm APPROVE diff --git a/docs/CONTRIBUTING.ja.md b/docs/CONTRIBUTING.ja.md index c6bb96f..f575060 100644 --- a/docs/CONTRIBUTING.ja.md +++ b/docs/CONTRIBUTING.ja.md @@ -38,9 +38,17 @@ npm test ### 2. TAKT レビューを実行する +レビューピースは入力内容からレビューモードを自動判定します: + ```bash -# PR を作成してからレビューを実行 +# PR モード — PR番号を指定してレビュー takt -t "#" -w review + +# ブランチモード — ブランチのmainとの差分をレビュー +takt -t "<ブランチ名>" -w review + +# 現在の差分モード — 未コミットや直近の変更をレビュー +takt -t "review current changes" -w review ``` ### 3. APPROVE を確認する