Skip to content

Document review scope selection#533

Open
Kevinjohn wants to merge 1 commit into
openai:mainfrom
Kevinjohn:docs/readme-review-scope
Open

Document review scope selection#533
Kevinjohn wants to merge 1 commit into
openai:mainfrom
Kevinjohn:docs/readme-review-scope

Conversation

@Kevinjohn

Copy link
Copy Markdown

Users cannot see how to select working-tree or branch review scope from the README even though both review commands support it.

Summary

  • Document the --scope auto|working-tree|branch option.
  • Explain how auto chooses a target and what the explicit scopes include.
  • Clarify that --base <ref> takes precedence and selects branch review.

Expected and actual

  • Expected: the README explains every review-target option exposed by the command frontmatter.
  • Actual: it documented --base, --wait, and --background, but omitted --scope and its selection behavior.

Validation

  • node --test tests/commands.test.mjs: 8 passed
  • node --test tests/*.test.mjs: 91 passed
  • git diff --check: clean

Actual screenshots

README diff — actual terminal output

README review scope documentation diff in the terminal

Focused validation — actual terminal output

Focused command documentation tests passing in the terminal

@Kevinjohn
Kevinjohn marked this pull request as ready for review July 19, 2026 23:03
@Kevinjohn
Kevinjohn requested a review from a team July 19, 2026 23:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant