Skip to content

CLAUDE.md

Latest commit

 

History

History
50 lines (36 loc) · 2.93 KB

CLAUDE.md

File metadata and controls

50 lines (36 loc) · 2.93 KB

CLAUDE.md

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

What This Repository Is

This is a Godot, C# curated collection of Claude Code rules, agents, skills, and examples. It is not a software application — it is a configuration and tooling repository that gets installed into target projects to standardize Claude Code behavior across teams.

Focused on: Godot (GDScript + C#), C# (.NET), Java (Spring Boot), Terraform, Go, Python. Azure cloud. Minimal frontend/JavaScript context.

Installation

# Install rules, agents, and skills for one or more languages
./install.sh <language> [<language> ...]
./install.sh golang java terraform
./install.sh --all

# PowerShell (Windows)
.\install.ps1 golang java terraform
.\install.ps1 -All

The installer always copies rules/common/ plus any requested language-specific rules, along with all agents and skills.

Repository Structure

  • rules/ — Markdown rule files loaded by Claude Code. Split into common/ (language-agnostic) and language-specific dirs (csharp/, godot/, golang/, java/, terraform/). These define coding style, security, testing, git workflow, performance, and agent orchestration conventions.
  • agents/ — Agent definitions (planner, architect, tdd-guide, code-reviewer, security-reviewer, build-error-resolver, refactor-cleaner). Referenced by rules to be used proactively during development workflows.
  • skills/ — Skill definitions (SKILL.md files) covering patterns for Spring Boot, Go, Python, JPA, Postgres, API design, security review, TDD, and more.
  • examples/ — Example CLAUDE.md files showing how target projects should configure their own project-level CLAUDE.md.
  • plugins/ — Plugin marketplace documentation (under review, not yet vetted).
  • install.sh — Bash installer (Linux/macOS).
  • install.ps1 — PowerShell installer (Windows).

Key Conventions Enforced by Rules

  • Git: Conventional commits (feat:, fix:, refactor:, etc.). Never create PRs at this level — that is left to project-level overrides or the user.
  • Development workflow: Research/reuse first → plan (planner agent) → TDD (tdd-guide agent) → code review (code-reviewer agent) → commit.
  • Immutability: Always create new objects, never mutate in place.
  • File size: 200-400 lines typical, 800 max. Many small files preferred.
  • Testing: TDD mandatory, 80% minimum coverage.
  • Agent usage: Agents should be invoked proactively (e.g., planner for complex features, tdd-guide for any new code, code-reviewer after writing). Parallel agent execution for independent tasks.

Adding New Content

  • New language rules go in rules/<language>/ as .md files.
  • New skills go in skills/<skill-name>/SKILL.md.
  • New agents go in agents/<name>.md.
  • After adding a language dir under rules/, the installer automatically picks it up — no script changes needed.