Skip to content

docs: update README.md to fix grammer #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 15, 2025
Merged

docs: update README.md to fix grammer #124

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5688e3d
docs: update README.md to fix gramer
shenxianpeng Jul 15, 2025
8f8d1ef
docs: update README.md
shenxianpeng Jul 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![GitHub marketplace](https://img.shields.io/badge/Marketplace-commit--check--action-blue)](https://github.com/marketplace/actions/commit-check-action)
[![slsa-badge](https://slsa.dev/images/gh-badge-level3.svg)](https://github.com/commit-check/commit-check-action/blob/a2873ca0482dd505c93fb51861c953e82fd0a186/action.yml#L59-L69)

A Github Action for checking commit message formatting, branch naming, committer name, email, commit signoff and more.
A GitHub Action for checking commit message formatting, branch naming, committer name, email, commit signoff, and more.

## Table of Contents

Expand All @@ -33,7 +33,7 @@ on:
jobs:
commit-check:
runs-on: ubuntu-latest
permissions: # use permissions because of use pr-comments
permissions: # use permissions because use of pr-comments
contents: read
pull-requests: write
steps:
Expand All @@ -43,15 +43,15 @@ jobs:
fetch-depth: 0 # required for merge-base check
- uses: commit-check/commit-check-action@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # use GITHUB_TOKEN because of use pr-comments
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # use GITHUB_TOKEN because use of pr-comments
with:
message: true
branch: true
author-name: true
author-email: true
commit-signoff: true
merge-base: false
imperative: true
imperative: false
job-summary: true
pr-comments: ${{ github.event_name == 'pull_request' }}
```
Expand Down Expand Up @@ -81,13 +81,13 @@ jobs:
### `message`

- **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`

Comment on lines 83 to 92
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ 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.

Suggested change
- **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.

### `author-name`
Expand All @@ -107,13 +107,13 @@ jobs:

### `merge-base`

- **Description**: check current branch is rebased onto target branch.
- **Description**: check current branch is rebased onto the target branch.
- Default: `false`

Comment on lines 108 to 112
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ 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.

Suggested change
### `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.

> [!IMPORTANT]
> `merge-base` is an experimental feature. by default it's disable.
> `merge-base` is an experimental feature. By default, it's disabled.
>
> To use this feature, you need fetch all history for all branches by setting `fetch-depth: 0` in `actions/checkout`.
> To use this feature, you need to fetch all history for all branches by setting `fetch-depth: 0` in `actions/checkout`.

### `imperative`

Expand All @@ -122,7 +122,7 @@ jobs:

### `dry-run`

- **Description**: run checks without failing. exit code is 0 otherwise is 1.
- **Description**: run checks without failing. exit code is 0; otherwise is 1.
- Default: `false`

### `job-summary`
Expand All @@ -136,11 +136,11 @@ jobs:
- Default: `false`

> [!IMPORTANT]
> `pr-comments` is an experimental feature. by default it's disable. To use it you need to set `GITHUB_TOKEN` in the GitHub Action.
> `pr-comments` is an experimental feature. By default, it's disabled. To use it, you need to set `GITHUB_TOKEN` in the GitHub Action.
>
> This feature currently doesn’t work with forked repositories. For more details, refer to issue [#77](https://github.com/commit-check/commit-check-action/issues/77).

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 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.

## GitHub Action Job Summary

Expand Down Expand Up @@ -191,4 +191,4 @@ Versioning follows [Semantic Versioning](https://semver.org/).

## Have questions or feedback?

To provide feedback (requesting a feature or reporting a bug) please post to [issues](https://github.com/commit-check/commit-check/issues).
To provide feedback (requesting a feature or reporting a bug), please post to [issues](https://github.com/commit-check/commit-check/issues).