yaml-development

Enforces YAML and KYAML formatting conventions with yamllint linting rules.

3|Updated May 1, 2026
One-click install
npx skills add https://github.com/MaterializeInc/materialize-monitoring --skill yaml-development-materializeinc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: yaml-development
Source: https://github.com/MaterializeInc/materialize-monitoring/tree/main/.claude/skills/yaml-development
Command: npx skills add https://github.com/MaterializeInc/materialize-monitoring --skill yaml-development-materializeinc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? YAML is unopinionated about formatting, which leads to inconsistent style across a repository. This Skill provides clear, enforced conventions for writing .yaml and .kyaml files so all configuration stays consistent and passes linting. ## Core Features & Use Cases - YAML Best Practices: Defines conventions for quoting, comments, multi-line strings, and file extensions, with a comprehensive annotated reference example. - Linting Guidance: Explains the .yamllint.yaml configuration, including which rules are warnings versus errors and which paths (Helm templates, generated files) are excluded. - KYAML Support: Covers the stricter KYAML subset (YAML with required braces/brackets, no power features) linted with --strict via a separate pre-commit hook. - Use Case: When editing a Helm values.yaml or authoring a new .kyaml config, use this Skill to write conforming files and preview lint results with uv run yamllint -c .yamllint.yaml <path> before committing. ## Quick Start Review and reformat my config.yaml file to follow the repository's YAML best practices and pass yamllint.

Frequently Asked Questions about yaml-development

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I lint YAML files with yamllint before committing?

Run `uv run yamllint -c .yamllint.yaml <path>` locally to preview exactly what the pre-commit hook will report. The hook runs automatically on `.yaml` and `.yml` files at commit time.

What is the difference between YAML and KYAML files?

KYAML is a stricter subset of YAML requiring braces and brackets, with no power features—think JSON with comments, multiple documents, and trailing commas. KYAML files use the `.kyaml` extension and are linted with `--strict`, so warnings also block commits.

Does yamllint check Helm chart templates?

No. Helm templates under `charts/*/templates/` are excluded because Go templating syntax is not valid YAML. However, Helm `values.yaml` files are linted and should follow the standard conventions.

Should YAML files use .yaml or .yml extension?

Use the `.yaml` extension unless `.yml` is strictly required by an external tool. This convention keeps file naming consistent across the repository.

Why does yamllint warn about quoted strings but not fail?

The `quoted-strings` rule is demoted to a warning to reduce toil. The convention is still double quotes for strings containing YAML metacharacters or starting with non-alphanumerics, but violations do not block commits.