You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- 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/).
91
91
- Default: `true`
92
92
93
93
### `author-name`
@@ -107,13 +107,13 @@ jobs:
107
107
108
108
### `merge-base`
109
109
110
-
- **Description**: check current branch is rebased onto target branch.
110
+
- **Description**: check current branch is rebased onto the target branch.
111
111
- Default: `false`
112
112
113
113
> [!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.
115
115
>
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`.
117
117
118
118
### `imperative`
119
119
@@ -122,7 +122,7 @@ jobs:
122
122
123
123
### `dry-run`
124
124
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.
126
126
- Default: `false`
127
127
128
128
### `job-summary`
@@ -136,11 +136,11 @@ jobs:
136
136
- Default: `false`
137
137
138
138
> [!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.
140
140
>
141
141
> 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).
142
142
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.
0 commit comments