Skip to content

Commit 76c671d

Browse files
authored
[chore] Added yamllint check (open-telemetry#2120)
1 parent 223702a commit 76c671d

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ requirements and recommendations.
3535
- [Misspell check](#misspell-check)
3636
- [Update the tables of content](#update-the-tables-of-content)
3737
- [Markdown link check](#markdown-link-check)
38+
- [Yamllint check](#yamllint-check)
3839
- [Merging existing ECS conventions](#merging-existing-ecs-conventions)
3940

4041
<!-- tocstop -->
@@ -339,6 +340,7 @@ For more information on each check, see:
339340
- [Markdown style](#markdown-style)
340341
- [Misspell check](#misspell-check)
341342
- [Markdown link check](#markdown-link-check)
343+
- [Yamllint check](#yamllint-check)
342344
- Prettier formatting
343345

344346
### Auto formatting
@@ -418,6 +420,20 @@ To check the validity of links in all markdown files, run the following command:
418420
make markdown-link-check
419421
```
420422

423+
### Yamllint check
424+
425+
To check the validity of all yaml files, run the following command:
426+
427+
```bash
428+
make yamllint
429+
```
430+
431+
If it is the first time to run this command, install `yamllint` first:
432+
433+
```bash
434+
make install-yamllint
435+
```
436+
421437
## Merging existing ECS conventions
422438

423439
The Elastic Common Schema (ECS) is being merged into OpenTelemetry Semantic

0 commit comments

Comments
 (0)