Skip to content

Fix grammar and readability in README.md#46

Merged
cyanzhong merged 2 commits intomainfrom
copilot/improve-readme-overall
Mar 18, 2026
Merged

Fix grammar and readability in README.md#46
cyanzhong merged 2 commits intomainfrom
copilot/improve-readme-overall

Conversation

Copy link
Contributor

Copilot AI commented Mar 18, 2026

Fix grammar issues and improve scannability of README.md.

  • Comma splices: Split run-on sentences in Installation ("…locally, install it…") and disabledLintKinds ("…to filter out, available kinds:")
  • Trailing punctuation: Add missing periods to all config option list items
  • Wording: "very big" → "large", "persisted at" → "stored at", "Presets disable" → "Each preset disables"
Original prompt

This section details on the original issue you should resolve

<issue_title>README.md</issue_title>
<issue_description>Improve the overall README.md, the goal is to fix grammar issues, make it easier to follow.</issue_description>

Comments on the Issue (you are @copilot in this section)


📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

Co-authored-by: cyanzhong <6745066+cyanzhong@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve overall README.md for clarity and grammar Fix grammar and readability in README.md Mar 18, 2026
Copilot AI requested a review from cyanzhong March 18, 2026 06:48
@cyanzhong cyanzhong marked this pull request as ready for review March 18, 2026 06:49
@cyanzhong cyanzhong merged commit 78db116 into main Mar 18, 2026
2 checks passed
@cyanzhong cyanzhong deleted the copilot/improve-readme-overall branch March 18, 2026 07:20
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.

README.md

2 participants