Skip to content

Commit 5688e3d

Browse files
authored
docs: update README.md to fix gramer
1 parent 38641d6 commit 5688e3d

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[![GitHub marketplace](https://img.shields.io/badge/Marketplace-commit--check--action-blue)](https://github.com/marketplace/actions/commit-check-action)
88
[![slsa-badge](https://slsa.dev/images/gh-badge-level3.svg)](https://github.com/commit-check/commit-check-action/blob/a2873ca0482dd505c93fb51861c953e82fd0a186/action.yml#L59-L69)
99

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

1212
## Table of Contents
1313

@@ -33,7 +33,7 @@ on:
3333
jobs:
3434
commit-check:
3535
runs-on: ubuntu-latest
36-
permissions: # use permissions because of use pr-comments
36+
permissions: # use permissions because use of pr-comments
3737
contents: read
3838
pull-requests: write
3939
steps:
@@ -51,7 +51,7 @@ jobs:
5151
author-email: true
5252
commit-signoff: true
5353
merge-base: false
54-
imperative: true
54+
imperative: false
5555
job-summary: true
5656
pr-comments: ${{ github.event_name == 'pull_request' }}
5757
```
@@ -81,13 +81,13 @@ jobs:
8181
### `message`
8282

8383
- **Description**: check commit message formatting convention.
84-
- By default the rule follows [conventional commits](https://www.conventionalcommits.org/).
84+
- By default, the rule follows [conventional commits](https://www.conventionalcommits.org/).
8585
- Default: `true`
8686

8787
### `branch`
8888

8989
- **Description**: check git branch naming convention.
90-
- By default the rule follows [conventional branch](https://conventional-branch.github.io/).
90+
- By default, the rule follows [conventional branch](https://conventional-branch.github.io/).
9191
- Default: `true`
9292

9393
### `author-name`
@@ -107,13 +107,13 @@ jobs:
107107

108108
### `merge-base`
109109

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

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

118118
### `imperative`
119119

@@ -122,7 +122,7 @@ jobs:
122122

123123
### `dry-run`
124124

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

128128
### `job-summary`
@@ -136,11 +136,11 @@ jobs:
136136
- Default: `false`
137137

138138
> [!IMPORTANT]
139-
> `pr-comments` is an experimental feature. by default it's disable. To use it you need to set `GITHUB_TOKEN` in the GitHub Action.
139+
> `pr-comments` is an experimental feature. By default, it's disabled. To use it, you need to set `GITHUB_TOKEN` in the GitHub Action.
140140
>
141141
> 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).
142142

143-
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.
143+
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.
144144

145145
## GitHub Action Job Summary
146146

@@ -191,4 +191,4 @@ Versioning follows [Semantic Versioning](https://semver.org/).
191191
192192
## Have questions or feedback?
193193
194-
To provide feedback (requesting a feature or reporting a bug) please post to [issues](https://github.com/commit-check/commit-check/issues).
194+
To provide feedback (requesting a feature or reporting a bug), please post to [issues](https://github.com/commit-check/commit-check/issues).

0 commit comments

Comments
 (0)