Skip to content

Commit 619f336

Browse files
committed
docs(commitlint): add missing docs
1 parent 5cb9eea commit 619f336

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

commitlint/README.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# `open-turo/action-pre-commit/commitlint`
2+
3+
<!-- prettier-ignore-start -->
4+
<!-- action-docs-description -->
5+
## Description
6+
7+
GitHub Action for running commitlint within the pre-commit action.
8+
<!-- action-docs-description -->
9+
<!-- action-docs-inputs -->
10+
## Inputs
11+
12+
| parameter | description | required | default |
13+
| --- | --- | --- | --- |
14+
| config-file | The config file to present to commitlint-github-action | `true` | .commitlintrc.yaml |
15+
| turo-conventional-commit | Set this to "false" to customize conventional commit config | `true` | true |
16+
| restore-config | Set to "false" to skip the configuration restore step | `false` | true |
17+
<!-- action-docs-inputs -->
18+
19+
<!-- action-docs-outputs -->
20+
21+
<!-- action-docs-outputs -->
22+
23+
<!-- action-docs-runs -->
24+
## Runs
25+
26+
This action is a `composite` action.
27+
<!-- action-docs-runs -->
28+
<!-- prettier-ignore-end -->
29+
30+
## Get Help
31+
32+
Please review Issues, post new Issues against this repository as needed.
33+
34+
## Contributions
35+
36+
Please see [here](https://github.com/open-turo/contributions) for guidelines on how to contribute to this project.

0 commit comments

Comments
 (0)