YAML Writing Guidelines

Objective: Define standards for writing clean, consistent, and valid YAML

Source File

View the full rule: .agent/rules/yaml.md

Sections

• 1. Document Structure
• 1. yamllint Compliance
• 1. Formatting & Style
• 1. Comments
• 1. Data Types & Scalars
• 1. Anchors & Aliases (DRY)
• 1. Ecosystem Linkage
• 1. Key Naming Conventions
• 1. Schema Validation & Editor Integration
• 1. YAML 1.1 vs 1.2 — Version Awareness
• 1. Common Pitfalls Quick Reference
• 1. Pre-commit & Toolchain Integration
• 1. File Organisation & Maintainability
• 1. Testing & Validation
• 1. Security & Sensitive Values