Files
MokoJoomHero/CLAUDE.md
T
mokogitea-actions[bot] 7ea6231bce
Generic: Project CI / Lint & Validate (pull_request) Successful in 6s
Generic: Project CI / Tests (pull_request) Failing after 5s
Universal: PR Check / Branch Policy (pull_request) Successful in 1s
Joomla: Extension CI / Release Readiness Check (pull_request) Failing after 3s
Universal: PR Check / Wiki Update Reminder (pull_request) Successful in 2s
Joomla: Extension CI / Lint & Validate (pull_request) Failing after 6s
Universal: PR Check / Require Docs Update (pull_request) Failing after 4s
Universal: PR Check / Secret Scan (pull_request) Successful in 5s
Generic: Repo Health / Access control (pull_request) Successful in 1s
Generic: Repo Health / Site Health (pull_request) Has been skipped
Joomla: Metadata Validation / Validate Joomla Metadata (pull_request) Failing after 8s
Universal: PR Check / Validate PR (pull_request) Failing after 11s
Branch Cleanup / Delete merged branch (pull_request) Has been skipped
RC Revert / Rename rc/ back to dev/ (pull_request) Has been skipped
Universal: Workflow Sync Trigger / Sync workflows to live repos (pull_request) Has been skipped
Universal: Auto Version Bump / Version Bump (push) Successful in 10s
Universal: Pre-Release / Build Pre-Release (${{ inputs.stability || github.ref_name }}) (push) Successful in 9s
Universal: Build & Release / Promote to RC (pull_request) Has been skipped
Universal: Build & Release / Build & Release Pipeline (pull_request) Failing after 5s
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
Generic: Repo Health / Scripts governance (pull_request) Has been cancelled
Generic: Repo Health / Repository health (pull_request) Has been cancelled
Generic: Repo Health / Report: Scripts Governance (pull_request) Has been cancelled
Generic: Repo Health / Report: Repository Health (pull_request) Has been cancelled
Merge remote-tracking branch 'origin/main' into dev
# Conflicts:
#	.mokogitea/manifest.xml
#	.mokogitea/workflows/auto-release.yml
#	.mokogitea/workflows/issue-branch.yml
#	.mokogitea/workflows/pr-check.yml
#	.mokogitea/workflows/pre-release.yml
#	CODE_OF_CONDUCT.md
#	SECURITY.md
#	src/language/en-GB/mod_mokojoomhero.ini
#	src/language/en-GB/mod_mokojoomhero.sys.ini
#	src/language/en-US/mod_mokojoomhero.ini
#	src/language/en-US/mod_mokojoomhero.sys.ini
#	src/media/css/mod_mokojoomhero.css
#	src/media/js/mod_mokojoomhero.js
#	src/mod_mokojoomhero.xml
2026-07-13 04:38:45 -05:00

2.2 KiB

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
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 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 MokoGitea wiki, not in docs/ files
  • Standards: this repo follows MokoStandards

Coding Standards

  • PHP 8.3+ minimum
  • SPDX license headers on all PHP files