Skip to content

Commit df776a0

Browse files
authored
Add YAML file linter (#6896)
This adds a corresponding configuration file `.yamllint.yaml` so that people can run `yamllint` to check the YAML files for syntax errors and conformance to style guidelines.
1 parent cc3b9d7 commit df776a0

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

.yamllint.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Summary: yamllint configuration for Cirq.
2+
# See https://yamllint.readthedocs.io/ for info about configuration options.
3+
4+
rules:
5+
line-length:
6+
# YAML files (especially GitHub Actions workflows) tend to end up with
7+
# long lines. The default of 80 is pretty limiting, and besides, in Python
8+
# code linting, we set line lengths to 100. May as well follow suit here.
9+
max: 100
10+
# Another common occurrence in YAML files is long URLs. The next two
11+
# settings are not specific to URLs, but help. It saves developer time by
12+
# not requiring comment directives to disable warnings at every occurrence.
13+
allow-non-breakable-words: true
14+
allow-non-breakable-inline-mappings: true

0 commit comments

Comments
 (0)