Files
MokoJoomHero/CLAUDE.md
T

1.7 KiB

CLAUDE.md

This file provides guidance to Claude Code when working with this repository.

Project Overview

MokoJoomHero -- A Joomla Module designed to provide a random image from a folder with content on top as a Hero.

Field Value
Platform joomla
Language PHP
Default branch main
License GPL-3.0-or-later
Wiki MokoJoomHero Wiki
Standards MokoStandards

Common Commands

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
composer install  # Install PHP dependencies

Architecture

This is a Joomla extension. Key directories:

  • src/ -- extension source (deployed to Joomla)
  • src/*.xml -- manifest file (version, files, params)
  • src/src/ or src/services/ -- PHP classes
  • src/language/ -- translation strings
  • src/media/ -- CSS/JS/images

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