diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..e3569c9 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,47 @@ +# CLAUDE.md + +This file provides guidance to Claude Code when working with this repository. + +## Project Overview + +**Template-Joomla** -- Unified Joomla extension scaffolding templates — plugin, template, module, component, package, library + +| Field | Value | +|---|---| +| **Platform** | template | +| **Language** | Markdown | +| **Default branch** | main | +| **License** | GPL-3.0-or-later | +| **Wiki** | [Template-Joomla Wiki](https://git.mokoconsulting.tech/MokoConsulting/Template-Joomla/wiki) | +| **Standards** | [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home) | + +## Common Commands + +```bash +make build # Build the project +make lint # Run linters +make validate # Validate structure +make release # Full release pipeline +make minify # Minify CSS/JS assets +make clean # Clean build artifacts +``` + +```bash +composer install # Install PHP dependencies +``` + +## Architecture + +This is a project template. Files are copied when creating new repos. +- Edit files here to change defaults for new projects +- `.gitea/workflows/` -- CI/CD workflow templates +- `Makefile` -- build targets inherited by new projects + +## Rules + +- **Never commit** `.claude/`, `.mcp.json`, `TODO.md`, or `*.min.css`/`*.min.js` +- **Attribution**: use `Authored-by: Moko Consulting` in commits +- **Branch strategy**: develop on `dev`, merge to `main` for release +- **Minification**: handled at build time (CI) and runtime (MokoMinifyHelper for Joomla templates) +- **Wiki**: documentation lives in the Gitea wiki, not in `docs/` files +- **Standards**: this repo follows [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)