docs: update README.md to fix grammer #124
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThe README.md file was updated with textual and stylistic improvements. These changes include corrections to capitalization, grammar, punctuation, and phrasing for better clarity and readability. Additionally, the default value of the Changes
Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Commit-Check ✔️ |
shenxianpeng
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (6)
README.md (6)
36-36: Tighten wording on the permissions inline-commentA minor grammar tweak makes the note flow better.
- permissions: # use permissions because use of pr-comments + permissions: # explicitly set permissions because PR comments require them
115-117: Optional wording polishReads a little smoother with “it” moved forward.
-> `merge-base` is an experimental feature. By default, it's disabled. +> `merge-base` is an experimental feature. It's disabled by default.
124-127: List style & clarity fordry-rundescription-* **Description**: run checks without failing. exit code is 0; otherwise is 1. +* **Description**: run checks without failing. Exit code is always `0`; otherwise `1`.
139-139: Minor wording tweak in thepr-commentsnote-> `pr-comments` is an experimental feature. By default, it's disabled. To use it, you need to set `GITHUB_TOKEN` in the GitHub Action. +> `pr-comments` is an experimental feature and is disabled by default. Enable it by setting `GITHUB_TOKEN` in the workflow.
143-144: Rephrase the “default rule” sentence for readability-Note: the default rule of above inputs is following [this configuration](https://github.com/commit-check/commit-check/blob/main/.commit-check.yml). If you want to customize, just add your `.commit-check.yml` config file under your repository root directory. +Note: The default behaviour of the inputs above follows [this configuration](https://github.com/commit-check/commit-check/blob/main/.commit-check.yml). To customise it, add a `.commit-check.yml` file to your repository root.
194-194: Tighten feedback sentence-To provide feedback (requesting a feature or reporting a bug), please post to [issues](https://github.com/commit-check/commit-check/issues). +To request a feature or report a bug, please open an [issue](https://github.com/commit-check/commit-check/issues).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(8 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
84-84: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
85-85: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
89-89: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
90-90: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
110-110: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
111-111: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
125-125: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
🔇 Additional comments (1)
README.md (1)
54-54: Change looks goodNo further issues spotted with the
imperativeflag line.
| - **Description**: check commit message formatting convention. | ||
| - By default the rule follows [conventional commits](https://www.conventionalcommits.org/). | ||
| - By default, the rule follows [conventional commits](https://www.conventionalcommits.org/). | ||
| - Default: `true` | ||
|
|
||
| ### `branch` | ||
|
|
||
| - **Description**: check git branch naming convention. | ||
| - By default the rule follows [conventional branch](https://conventional-branch.github.io/). | ||
| - By default, the rule follows [conventional branch](https://conventional-branch.github.io/). | ||
| - Default: `true` | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Unify list-marker style to satisfy markdown-lint
markdownlint flags these lines for using - while the rest of the doc uses *.
Switching keeps the style consistent and silences MD004.
- - By default, the rule follows [conventional commits](https://www.conventionalcommits.org/).
+ * By default, the rule follows [conventional commits](https://www.conventionalcommits.org/).
…
- - By default, the rule follows [conventional branch](https://conventional-branch.github.io/).
+ * By default, the rule follows [conventional branch](https://conventional-branch.github.io/).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **Description**: check commit message formatting convention. | |
| - By default the rule follows [conventional commits](https://www.conventionalcommits.org/). | |
| - By default, the rule follows [conventional commits](https://www.conventionalcommits.org/). | |
| - Default: `true` | |
| ### `branch` | |
| - **Description**: check git branch naming convention. | |
| - By default the rule follows [conventional branch](https://conventional-branch.github.io/). | |
| - By default, the rule follows [conventional branch](https://conventional-branch.github.io/). | |
| - Default: `true` | |
| - **Description**: check commit message formatting convention. | |
| * By default, the rule follows [conventional commits](https://www.conventionalcommits.org/). | |
| - Default: `true` | |
| ### `branch` | |
| - **Description**: check git branch naming convention. | |
| * By default, the rule follows [conventional branch](https://conventional-branch.github.io/). | |
| - Default: `true` |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
83-83: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
84-84: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
85-85: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
89-89: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
90-90: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
91-91: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
🤖 Prompt for AI Agents
In README.md around lines 83 to 92, the list markers use '-' while the rest of
the document uses '*', causing markdownlint MD004 warnings. Change all '-' list
markers in this section to '*' to unify the list-marker style and maintain
consistency throughout the document.
| ### `merge-base` | ||
|
|
||
| - **Description**: check current branch is rebased onto target branch. | ||
| - **Description**: check current branch is rebased onto the target branch. | ||
| - Default: `false` | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix MD004 and capitalisation in the merge-base description
-* **Description**: check current branch is rebased onto the target branch.
+* **Description**: check that the current branch is rebased onto the target branch.Also swaps - for * to keep list-marker style consistent.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### `merge-base` | |
| - **Description**: check current branch is rebased onto target branch. | |
| - **Description**: check current branch is rebased onto the target branch. | |
| - Default: `false` | |
| ### `merge-base` | |
| * **Description**: check that the current branch is rebased onto the target branch. | |
| - Default: `false` |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
110-110: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
111-111: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
🤖 Prompt for AI Agents
In README.md around lines 108 to 112, fix the markdown linting issue MD004 by
ensuring consistent list marker style by replacing the dash (-) with an asterisk
(*). Also, capitalize the first letter of the description for `merge-base` to
maintain proper sentence case. Update the list item to start with "*
Description: Check current branch is rebased onto the target branch." and keep
the rest of the formatting consistent.
Summary by CodeRabbit