| layout | title | category | tags | order | |
|---|---|---|---|---|---|
style-guide |
YAML Style Guide |
style-guide |
|
6 |
In order to make our YAML configuration easy to read, we use an automated formatter to ensure that it's up to scratch.
The bulk of the heavy lifting for formatting our YAML is done by the formatter
prettier. This formatter should be run on the entire
repository using npx prettier --write . before every pull request.
For instructions on how to install it, please see our contributing guidelines.
If you notice files in generated code being formatted by prettier, please add
them to the .prettierignore file.
When bumping the version of prettier, please commit the resultant configuration formatting changes along with the bump as a separate PR from any functional code changes.