Skip to content

Commit 178fe48

Browse files
Kranthi PoturajuKranthi Poturaju
authored andcommitted
docs: fix spelling, formatting, and accuracy issues in README
1 parent b948419 commit 178fe48

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Commitlint Github Action
1+
# Commitlint GitHub Action
22

33
Lints Pull Request commits with [commitlint](https://commitlint.js.org/).
44

@@ -51,11 +51,11 @@ jobs:
5151
- uses: wagoid/commitlint-github-action@v6
5252
```
5353

54-
#### Important Note:
54+
#### Important Note
5555

56-
To ensure that the merge_group event triggers correctly, you need to have **at least one workflow that responds to the pull_request event** with a job named the same as the one in your merge_group workflow (**commitlint** in this example). This is necessary because the merge queue relies on the existence of status checks from the pull request context.
56+
To ensure that the `merge_group` event triggers correctly, you need to have **at least one workflow that responds to the `pull_request` event** with a job named the same as the one in your `merge_group` workflow (**commitlint** in this example). This is required because the merge queue relies on status checks from the pull request context.
5757

58-
Here's a minimal pull_request workflow to satisfy this requirement:
58+
Here's a minimal `pull_request` workflow to satisfy this requirement:
5959

6060
```yaml
6161
name: Placeholder Workflow for Merge Queue
@@ -92,13 +92,13 @@ You can supply these inputs to the `wagoid/commitlint-github-action@v6` step.
9292

9393
The path to your commitlint config file.
9494

95-
Default: `commitlint.config.mjs`
95+
Default: `./commitlint.config.mjs`
9696

9797
If the config file doesn't exist, [config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) settings will be loaded as a default fallback.
9898

9999
Details on the configuration file can be found on [the commitlint website](https://commitlint.js.org/#/reference-configuration).
100100

101-
Note: `commitlint.config.js` doesn't work with this action. If you use a JS config file, it's required to be an ES Module (`.mjs` extension)
101+
**Note:** `commitlint.config.js` does not work with this action. If you use a JS config file, it must use the ES Module format (`.mjs` extension).
102102

103103
### `failOnWarnings`
104104

@@ -108,29 +108,29 @@ Default: `false`
108108

109109
### `failOnErrors`
110110

111-
Whether you want to fail on errors or not. Still outputs the results, just forces the action to pass even if errors are detected.
111+
Whether to fail the action when errors are detected. When set to `false`, the action still outputs results but always passes.
112112

113113
Default: `true`
114114

115115
### `helpURL`
116116

117117
Link to a page explaining your commit message convention.
118118

119-
default: `https://github.com/conventional-changelog/commitlint/#what-is-commitlint`
119+
Default: `https://github.com/conventional-changelog/commitlint/#what-is-commitlint`
120120

121121
### `commitDepth`
122122

123123
When set to a valid Integer value - X, considers only the latest X number of commits.
124124

125-
default: `null` (Equivalent to linting all commits)
125+
Default: `null` (Equivalent to linting all commits)
126126

127127
### `token`
128128

129129
Personal access token (PAT) used to interact with the GitHub API.
130130
By default, the automatic token provided by GitHub is used.
131-
You can see more info about GitHub's default token [here](https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token).
131+
You can see more info about GitHub's automatic token [here](https://docs.github.com/en/actions/tutorials/authenticate-with-github_token).
132132

133-
default: `${{ github.token }}`
133+
Default: `${{ github.token }}`
134134

135135
## Outputs
136136

@@ -157,28 +157,28 @@ You have commit messages with errors
157157
ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
158158
```
159159

160-
```JSON
160+
```json
161161
[
162162
{
163163
"hash": "cb0f846f13b490c2fd17bd5ed0b6f65ba9b86c75",
164164
"message": "wrong message",
165165
"valid": false,
166166
"errors": ["subject may not be empty", "type may not be empty"],
167-
"warnings": [],
167+
"warnings": []
168168
},
169169
{
170170
"hash": "cb14483cbde23b61322ffb8d3fcdc87f514a3141",
171171
"message": "chore: my message\n\nsome context without leading blank line",
172172
"valid": true,
173173
"errors": [],
174-
"warnings": ["body must have leading blank line"],
175-
},
174+
"warnings": ["body must have leading blank line"]
175+
}
176176
]
177177
```
178178

179179
## About `extends` in your config file
180180

181-
This is a [`Docker` action](https://github.com/actions/toolkit/blob/e2adf403d6d14a9ca7474976ccaca20f72ff8209/docs/action-types.md#why-would-i-choose-a-docker-action), and was made like this so that you can run it with minimum setup, regardless of your repo's environment. It comes packed with the most famous shared configurations that you can use in your commitlint config's `extends` field:
181+
This is a [Docker action](https://github.com/actions/toolkit/blob/e2adf403d6d14a9ca7474976ccaca20f72ff8209/docs/action-types.md#why-would-i-choose-a-docker-action), and was built this way so that you can run it with minimum setup, regardless of your repo's environment. It comes packed with the most famous shared configurations that you can use in your commitlint config's `extends` field:
182182

183183
- [@commitlint/config-angular](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-angular)
184184
- [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional)
@@ -188,9 +188,9 @@ This is a [`Docker` action](https://github.com/actions/toolkit/blob/e2adf403d6d1
188188
- [commitlint-config-jira](https://github.com/Gherciu/commitlint-jira)
189189
- [commitlint-config-function-rules](https://github.com/vidavidorra/commitlint-plugin-function-rules#readme)
190190

191-
Apart from the shared configurations that are included by default, you can also include extra dependencies for other configs and plugins that you want to use.
191+
In addition to the shared configurations included by default, you can also add extra dependencies for other configs and plugins.
192192

193-
In order to do so, you can use `NODE_PATH` env var to make the action take those dependencies into account. Below is an example workflow that does that.
193+
To do so, you can use the `NODE_PATH` environment variable to make the action include those dependencies. Below is an example workflow.
194194

195195
```yaml
196196
name: Lint Commit Messages

0 commit comments

Comments
 (0)