[Suggestion] Document minimum Git version requirement

[skate29]

Issue Type

Other

Document Location

README.md

Description

$ git version
git version 2.27.0.windows.1

git --no-pager grep -i -F -n --no-color --max-count 100 -e "ProcessStsEnum" -- xxxx/xxxx/x
error: unknown option `max-count'

Suggested Change

Hi,

I would like to suggest adding the minimum Git version requirement to the project documentation.

I encountered compatibility issues with older Git versions. Specifically, the command git grep --max-count is not recognized, resulting in the following error:
$ git version
git version 2.27.0.windows.1

git --no-pager grep -i -F -n --no-color --max-count 100 -e "ProcessStsEnum" -- xxxx/xxxx/x
error: unknown option `max-count'

[lizhengfeng101]

Thanks for reporting this! That's a great suggestion.

The --max-count option for git grep was introduced in Git 2.38. We should definitely document the minimum Git version requirement to help users avoid this kind of issue.

Would you be interested in submitting a PR to add this to the README? We'd love to have your contribution!

[skate29]

Hi,

Thank you for the invitation! I would be very happy to update the documentation.

I plan to add a new “Prerequisites” section under the existing “How to Use” heading. Specifically, I will insert it right before the ### CLI subsection.

Here is the content I intend to add:

Prerequisites

• Git >= 2.38 — Open Code Review reads Git diffs and requires Git 2.38 or later.

[lizhengfeng101]

Hi,

Thank you for the invitation! I would be very happy to update the documentation.

I plan to add a new “Prerequisites” section under the existing “How to Use” heading. Specifically, I will insert it right before the ### CLI subsection.

Here is the content I intend to add:

Prerequisites

• Git >= 2.38 — Open Code Review reads Git diffs and requires Git 2.38 or later.

Agreed on the design — looking forward to your PR! @skate29

[chethanuk]

This landed: #261 added the Prerequisites section to the README, and d1ef549 bumped it to Git >= 2.41 and synced all localized READMEs; the docs-site QuickStart lists the same requirement. Looks like this can be closed.