ntwl/CLAUDE.md

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Commands

• Validate YAML: kubectl --dry-run=client -f <filename.yaml>
• Validate syntax with YAML linter: yamllint <filename.yaml>
• Check Kubernetes resources: kubectl get <resource-type> --namespace <namespace>

Style Guidelines

1. YAML Formatting:

   • Use 2-space indentation
   • Use snake_case for keys
   • Keep line length under 100 characters

2. Kubernetes Resources:

   • Include resource limits/requests in all deployments
   • Add appropriate labels and annotations
   • Group related resources in the same file
   • Use namespaces to organize resources by service

3. Documentation:

   • Add comments for non-obvious configuration choices
   • Document environment-specific variables clearly