Jonathan Miller
ea9ea5c3a7
Generic: Repo Health / Site Health (push) Has been cancelled
Generic: Repo Health / Access control (push) Has been cancelled
Universal: PR Check / Branch Policy (pull_request) Has been cancelled
Universal: Build & Release / Build & Release Pipeline (pull_request) Has been cancelled
Joomla: Extension CI / Release Readiness Check (pull_request) Has been cancelled
Universal: Secret Scanning / Gitleaks Secret Scan (pull_request) Has been cancelled
Joomla: Extension CI / Lint & Validate (pull_request) Has been cancelled
Universal: Build & Release / Promote to RC (pull_request) Has been cancelled
Universal: PR Check / Validate PR (pull_request) Has been cancelled
Generic: Repo Health / Scripts governance (push) Has been cancelled
Generic: Repo Health / Repository health (push) Has been cancelled
Generic: Repo Health / Report Issues (push) Has been cancelled
Joomla: Extension CI / Tests (PHP 8.2) (pull_request) Has been cancelled
Joomla: Extension CI / Tests (PHP 8.3) (pull_request) Has been cancelled
Joomla: Extension CI / PHPStan Analysis (pull_request) Has been cancelled
Joomla: Extension CI / Build RC Pre-Release (pull_request) Has been cancelled
Universal: PR Check / Build RC Package (pull_request) Has been cancelled
Universal: PR Check / Report Issues (pull_request) Has been cancelled
Remove plg_system_mokojoomhero and package wrapper. Move module files from src/packages/mod_mokojoomhero/ back to src/. Update Makefile build target for module ZIP. Update CLAUDE.md and file PATH headers. Authored-by: Moko Consulting Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
65 lines
2.2 KiB
Markdown
65 lines
2.2 KiB
Markdown
# CLAUDE.md
|
|
|
|
This file provides guidance to Claude Code when working with this repository.
|
|
|
|
## Project Overview
|
|
|
|
**MokoJoomHero** -- Random hero image slideshow/video with content overlay for Joomla
|
|
|
|
| Field | Value |
|
|
|---|---|
|
|
| **Platform** | joomla |
|
|
| **Language** | PHP |
|
|
| **Default branch** | main |
|
|
| **License** | GPL-3.0-or-later |
|
|
| **Wiki** | [MokoJoomHero Wiki](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomHero/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 Joomla **site module** (`mod_mokojoomhero`).
|
|
|
|
- Random hero image slideshow or background video with content overlay
|
|
- Supports image folders, YouTube, Vimeo, local video, solid colour, gradient
|
|
- Configurable overlay, text alignment, card animation, parallax, content animations
|
|
- A/B testing with weighted variations, scheduling with start/end datetime
|
|
- Article content source, per-slide unique content via subform
|
|
|
|
### Key files
|
|
- `src/mod_mokojoomhero.xml` — module manifest
|
|
- `src/mod_mokojoomhero.php` — module entry point
|
|
- `src/tmpl/default.php` — template
|
|
- `src/media/` — CSS, JS, and web asset registry
|
|
- `src/language/` — en-GB and en-US translations
|
|
- `src/script.php` — install script (creates default image folder)
|
|
|
|
## Rules
|
|
|
|
- **Workflow directory**: `.mokogitea/` (not `.gitea/` or `.github/`)
|
|
- **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)
|
|
- **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)
|
|
|
|
## Coding Standards
|
|
|
|
- PHP 8.1+ minimum
|
|
- SPDX license headers on all PHP files
|