MokoWaaS Component
Standard repository structure for MokoWaaS (Joomla) components
waas-component
mokowaas
2026-01-30T00:00:00Z
Moko Consulting
README.md
Developer-focused documentation for contributors and maintainers
required
developer
LICENSE
License file (GPL-3.0-or-later) - Default for Joomla/WaaS components
required
general
templates/licenses/GPL-3.0
GPL-3.0-or-later
CHANGELOG.md
Version history and changes
required
general
SECURITY.md
Security policy and vulnerability reporting
required
general
CODE_OF_CONDUCT.md
Community code of conduct
required
true
contributor
ROADMAP.md
Project roadmap with version goals and milestones
optional
general
CONTRIBUTING.md
Contribution guidelines
required
contributor
Makefile
Build automation using MokoStandards templates
required
true
developer
templates/makefiles
Makefile.joomla.template
template
.
Makefile
false
templates/makefiles/Makefile.joomla.template
.gitignore
Git ignore patterns for Joomla development - preserved during sync operations
required
false
developer
templates/configs/.gitignore.joomla
content-pattern
Must contain sftp-config pattern to ignore SFTP sync configuration files
sftp-config
error
content-pattern
Must contain user.css pattern to ignore custom user CSS overrides
user\.css
error
content-pattern
Must contain user.js pattern to ignore custom user JavaScript overrides
user\.js
error
content-pattern
Must contain modulebuilder.txt pattern to ignore Joomla Module Builder artifacts
modulebuilder\.txt
error
content-pattern
Must contain colors_custom.css pattern to ignore custom color scheme overrides
colors_custom\.css
error
.gitattributes
Git attributes configuration
required
developer
.editorconfig
Editor configuration for consistent coding style - preserved during sync
required
false
developer
site
Component frontend (site) code
required
Contains frontend component code deployed to site
controller.php
Main site controller
required
developer
manifest.xml
Component manifest for site
required
developer
controllers
Site controllers
suggested
models
Site models
suggested
views
Site views
required
admin
Component backend (admin) code
required
Contains backend component code for administrator
controller.php
Main admin controller
required
developer
controllers
Admin controllers
suggested
models
Admin models
suggested
views
Admin views
required
sql
Database schema files
suggested
media
Media files (CSS, JS, images)
suggested
Contains static assets
css
Stylesheets
suggested
js
JavaScript files
suggested
images
Image files
suggested
language
Language translation files
required
Contains language INI files
docs
Developer and technical documentation
required
Contains technical documentation, API docs, architecture diagrams
index.md
Documentation index
required
scripts
Build and maintenance scripts
required
Contains scripts for building, testing, and deploying
index.md
Scripts documentation
required
build_package.sh
Package building script for Joomla component
suggested
templates/scripts/release/package_joomla.sh
validate_manifest.sh
Manifest validation script
suggested
templates/scripts/validate/manifest.sh
MokoStandards.override.xml
MokoStandards sync override configuration - preserved during sync
suggested
false
developer
tests
Test files
required
Contains unit tests, integration tests, and test fixtures
unit
Unit tests
required
integration
Integration tests
suggested
.github
GitHub-specific configuration
suggested
Contains GitHub Actions workflows, issue templates, etc.
workflows
GitHub Actions workflows
required
ci-joomla.yml
Joomla-specific CI workflow
required
true
templates/workflows/joomla/ci-joomla.yml.template
codeql-analysis.yml
CodeQL security analysis workflow
required
true
templates/workflows/generic/codeql-analysis.yml.template
standards-compliance.yml
MokoStandards compliance validation
required
true
.github/workflows/standards-compliance.yml