jungho-git/yaml

YAML

• Shared examples and formatting reference: references/EXAMPLE.md.
• Keep new guidance, snippets, and edits aligned with that file.

Scope

Use this rule when:

• editing .yml or .yaml files
• changing CI/CD pipelines, Kubernetes manifests, Docker Compose, app config, or skill agent manifests
• reviewing configuration drift or schema changes

YAML edits should avoid indentation drift, type coercion, and accidental secret exposure.

Core Rules

• Use 2-space indentation.
• Never mix tabs and spaces.
• Quote strings containing special characters.
• Quote strings that look like booleans, numbers, nulls, dates, or YAML keywords.
• Prefer block style (| or >) for multiline strings.
• Avoid escaped newline strings for multiline content.
• Do not use anchors and aliases for complex structures unless local config relies on them.
• Keep key order stable by local convention.
• Validate against the target schema after structural changes.

Security

• Never store plaintext secrets in committed YAML.
• Use environment variable substitution, secret references, or external secret managers.
• Do not paste tokens, cookies, passwords, private keys, or production credentials into examples.

Formatting

• Never vertically align values.
• Do not pad spaces to line up keys or colons.
• Keep compact standard style.
• Use block scalars for prompts, scripts, or multiline descriptions.

Validation Focus

• indentation consistency
• unintended type coercion
• multiline string behavior
• required keys and schema constraints
• secret exposure
• agent manifest field placement