docs: add review mode examples to CONTRIBUTING

This commit is contained in:
nrslib 2026-02-28 09:48:18 +09:00
parent b8b64f858b
commit c7389a5b24
2 changed files with 18 additions and 2 deletions

View File

@ -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 "#<PR-number>" -w review
# Branch mode — review a branch diff against main
takt -t "<branch-name>" -w review
# Current diff mode — review uncommitted or recent changes
takt -t "review current changes" -w review
```
### 3. Confirm APPROVE

View File

@ -38,9 +38,17 @@ npm test
### 2. TAKT レビューを実行する
レビューピースは入力内容からレビューモードを自動判定します:
```bash
# PR を作成してからレビューを実行
# PR モード — PR番号を指定してレビュー
takt -t "#<PR番号>" -w review
# ブランチモード — ブランチのmainとの差分をレビュー
takt -t "<ブランチ名>" -w review
# 現在の差分モード — 未コミットや直近の変更をレビュー
takt -t "review current changes" -w review
```
### 3. APPROVE を確認する