claude-code-toolkit CLAUDE.md

Claude Code Toolkit — Claude Code Instructions

Project Overview

Type: Documentation / Templates Repository Purpose: Collection of CLAUDE.md templates, components, and examples for Claude Code projects Stack: Markdown, Shell scripts, YAML configs

---

Quality Checks (MUST PASS)

This project has CI/CD checks. All PRs must pass before merge.

Run All Checks Locally

make check

Individual Checks

# Shell scripts
make shellcheck

# Markdown lint
make lint

# Validate templates
make validate

---

Markdown Formatting (CRITICAL)

All markdown files MUST pass markdownlint checks.

Common Errors to Avoid

1. MD040 — Always specify language for code blocks

   <!-- WRONG -->
   ` ` `
   code here
   ` ` `
   
   <!-- CORRECT -->
   ` ` `bash
   code here
   ` ` `
   

2. MD031/MD032 — Add blank lines around code blocks and lists

   <!-- WRONG -->
   Text
   - item
   Text
   
   <!-- CORRECT -->
   Text
   
   - item
   
   Text
   

3. MD026 — No punctuation at end of headings

   <!-- WRONG -->
   ## What is this?
   
   <!-- CORRECT -->
   ## What is This
   

Quick Fix

npx markdownlint-cli "**/*.md" --ignore node_modules --fix

---

Project Structure

claude-guides/
├── templates/           # CLAUDE.md templates (base, laravel, nextjs)
│   └── */CLAUDE.md     # Template files
│   └── */settings.json # VS Code settings
├── components/          # Reusable sections for CLAUDE.md
│   └── *.md            # Individual components
├── examples/            # Complete project examples
│   └── */CLAUDE.md     # Example configurations
├── commands/            # Claude Code slash commands
│   └── *.md            # Command definitions
├── scripts/             # Utility scripts
└── .github/             # CI/CD workflows

---

File Naming Conventions

• Components: kebab-case.md (e.g., plan-mode-instructions.md)
• Templates: Directory with CLAUDE.md inside
• Commands: kebab-case.md in commands/ directory