Skip to content
This repository was archived by the owner on Oct 22, 2021. It is now read-only.

Commit 7041b3f

Browse files
committed
Update docs with yamllint
1 parent 3654e1a commit 7041b3f

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

doc/Contribute.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -97,18 +97,20 @@ associated documentation, if we have any.
9797

9898
## Linting
9999

100-
Currently only one linter is available:
100+
Currently, 2 linters are available:
101101

102102
- `dev/linters/shellcheck.sh`
103+
- `dev/linters/yamllint.sh`
103104

104-
Invoke this linter as
105+
Invoke these linters as
105106

106107
```sh
107108
dev/linters/shellcheck.sh
109+
dev/linters/yamllint.sh
108110
```
109111

110-
to run shellcheck on all `.sh` files found in the entire checkout and
111-
report any issues found.
112+
to run shellcheck on all `.sh` files found in the entire checkout, or yamllint
113+
on all `.yaml` or `.yml` files respectively, and report any issues found.
112114

113115
## Patching
114116

doc/linters.md

+5
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,8 @@ The following linters are available:
99

1010
Runs shellcheck on all `.sh` files found in the entire checkout
1111
and reports any issues found.
12+
13+
- `yamllint.sh`:
14+
15+
Runs yamllint on all `.{yaml,yml}` files found in the entire checkout
16+
and reports any issues found.

0 commit comments

Comments
 (0)