From b93d374dafdce69fd34fb3975cc222fabd65b5f5 Mon Sep 17 00:00:00 2001 From: Ritvvvik Date: Fri, 31 Jul 2026 00:34:33 +0530 Subject: [PATCH 1/2] docs: clarify --from/--to uses merge-base (three-dot) semantics Fixes #579. internal/diff/git.go's ModeRange computes the range via the two refs' merge-base, matching the CLI --help text (flags.go:206, 'merge-base mode'). The three Quickstart locales incorrectly described this as a..b (two-dot) comparison; README.md was ambiguous. All four now describe the actual merge-base behavior in plain language rather than relying on git dot-notation. --- README.md | 2 +- pages/src/content/docs/en/quickstart.md | 2 +- pages/src/content/docs/ja/quickstart.md | 2 +- pages/src/content/docs/zh/quickstart.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1f20ffde7..4ca2ceae0 100644 --- a/README.md +++ b/README.md @@ -135,7 +135,7 @@ cd your-project # Workspace mode — review all staged, unstaged, and untracked changes ocr review -# Branch range — compare two refs +# Branch range — reviews feature-branch's changes since it diverged from main (merge-base mode) ocr review --from main --to feature-branch # Single commit diff --git a/pages/src/content/docs/en/quickstart.md b/pages/src/content/docs/en/quickstart.md index 31aa767ac..4b485eeb9 100644 --- a/pages/src/content/docs/en/quickstart.md +++ b/pages/src/content/docs/en/quickstart.md @@ -66,7 +66,7 @@ cd path/to/your-repo # Workspace mode — reviews staged + unstaged + untracked changes (default) ocr review -# Branch range — reviews `main..feature-branch` +# Branch range — reviews feature-branch's changes since it diverged from main (merge-base mode) ocr review --from main --to feature-branch # Single commit — reviews the diff that commit introduced diff --git a/pages/src/content/docs/ja/quickstart.md b/pages/src/content/docs/ja/quickstart.md index 4f034513b..dfbce1f2e 100644 --- a/pages/src/content/docs/ja/quickstart.md +++ b/pages/src/content/docs/ja/quickstart.md @@ -66,7 +66,7 @@ cd path/to/your-repo # ワークスペースモード —— staged + unstaged + untracked の変更をレビュー（デフォルト） ocr review -# ブランチ区間 —— `main..feature-branch` をレビュー +# ブランチ区間 —— main から分岐した後の feature-branch の変更をレビュー（マージベースモード） ocr review --from main --to feature-branch # 単一 commit —— その commit が導入した diff をレビュー diff --git a/pages/src/content/docs/zh/quickstart.md b/pages/src/content/docs/zh/quickstart.md index 77117115e..40b064434 100644 --- a/pages/src/content/docs/zh/quickstart.md +++ b/pages/src/content/docs/zh/quickstart.md @@ -66,7 +66,7 @@ cd path/to/your-repo # 工作区模式 —— 评审 staged + unstaged + untracked 变更（默认） ocr review -# 分支区间 —— 评审 `main..feature-branch` +# 分支区间 —— 评审 feature-branch 自与 main 分叉以来的变更（合并基准模式） ocr review --from main --to feature-branch # 单个 commit —— 评审该 commit 引入的 diff From 8006a628d5e3998452d6b70e428f4203b4bc0e74 Mon Sep 17 00:00:00 2001 From: Ritvvvik Date: Fri, 31 Jul 2026 13:31:56 +0530 Subject: [PATCH 2/2] docs: sync merge-base wording to remaining locale READMEs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Addresses review feedback on #613 — zh-CN, ja-JP, ko-KR, ru-RU README comments still described the old (incorrect) two-dot comparison. --- README.ja-JP.md | 2 +- README.ko-KR.md | 2 +- README.ru-RU.md | 2 +- README.zh-CN.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.ja-JP.md b/README.ja-JP.md index bea7652af..192ae3976 100644 --- a/README.ja-JP.md +++ b/README.ja-JP.md @@ -135,7 +135,7 @@ cd your-project # ワークスペースモード — ステージ済み・未ステージ・未追跡のすべての変更をレビュー ocr review -# ブランチ範囲 — 2つのrefを比較 +# ブランチ範囲 — main から分岐した後の feature-branch の変更をレビュー（マージベースモード） ocr review --from main --to feature-branch # 単一コミット diff --git a/README.ko-KR.md b/README.ko-KR.md index 78f7b7c14..09584cae9 100644 --- a/README.ko-KR.md +++ b/README.ko-KR.md @@ -135,7 +135,7 @@ cd your-project # Workspace mode: staged, unstaged, untracked 변경을 모두 리뷰 ocr review -# Branch range: 두 ref 비교 +# 브랜치 범위 — main에서 분기된 이후 feature-branch의 변경 사항을 리뷰합니다 (머지베이스 모드) ocr review --from main --to feature-branch # 단일 commit diff --git a/README.ru-RU.md b/README.ru-RU.md index 33e558e13..026c4c9d3 100644 --- a/README.ru-RU.md +++ b/README.ru-RU.md @@ -135,7 +135,7 @@ cd your-project # Режим рабочей копии — ревью всех staged, unstaged и untracked изменений ocr review -# Диапазон веток — сравнение двух ref'ов +# Диапазон веток — просматривает изменения feature-branch с момента её отделения от main (режим merge-base) ocr review --from main --to feature-branch # Один коммит diff --git a/README.zh-CN.md b/README.zh-CN.md index 7a3241af9..a961dc7d1 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -135,7 +135,7 @@ cd your-project # 工作区模式 —— 审查所有暂存、未暂存和未跟踪的变更 ocr review -# 分支范围 —— 比较两个引用 +# 分支范围 —— 评审 feature-branch 自与 main 分叉以来的变更（合并基准模式） ocr review --from main --to feature-branch # 单个提交