GoogleCloudPlatform / GoogleCloudPlatform/kubernetes-engine-samples

Enforce consistent YAML style/structure via a YAML linter

Open
#1,688 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HCL
Stars
1.4k
Forks
1.3k
Avg merge
2d 2h
Merged PRs (30d)
4

Description

* Use automation to enforce consistent code style and structure across our YAML files (i.e., run a linter on pull-requests).
* Why is this important?
* See the number of style (e.g., spacing/indent) related diffs in this pull-request: https://github.com/GoogleCloudPlatform/kubernetes-engine-samples/pull/1685/files. Enforcing a single, consistent style for YAML files would allow developers (and reviewers) to focus more on just the changes that primarily impact the functionality of the YAML files.
* This would also improve the overall "readability" of our YAML samples.
* Additional thoughts:
* We should default to common community practices/standards (so that our samples are more copy-pastable).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.