styleguide icon indicating copy to clipboard operation
styleguide copied to clipboard

yaml: Consider adding a YAML style guide

Open nielm opened this issue 1 year ago • 2 comments

Consider adding a style guide for YAML files.

Google has a YAML formatter with a certain set of default rules , which I assume expresses the style guide...

https://github.com/google/yamlfmt/blob/main/docs/config-file.md

nielm avatar Jul 17 '24 19:07 nielm

we don't have a style guide. that formatter is the only thing we have. and even its README is clear:

This tool is not yet officially supported by Google. It is currently maintained solely by @braydonk, and unless something changes primarily in spare time.

vapier avatar Dec 03 '24 04:12 vapier

Yes, to be clear the yamlfmt project doesn't make any attempt to lay out an opinionated style. The formatting is done by round-trip-ing yaml through a particular yaml parser in Go, so the default is just however that library decides to format it on output. It wasn't thought out in any way.

braydonk avatar Dec 03 '24 13:12 braydonk