Checklist: the theme extension is ready #

This page is for designers about to release or hand over a theme. Copy the list into your release issue and tick it.

Structure and metadata #

• To do: extension/<name>/ uses a valid name (Naming).
• To do: ezinfo.php passes php -l and shows name, version, copyright, license, website.
• To do: extension.xml passes xmllint --noout and agrees with ezinfo.php.
• To do: Every version field shows the release number (Keeping every version field in sync).
• To do: LICENSE holds the official text; third-party notices sit next to their assets.
• To do: README.md, and INSTALL.md if installing takes more than one step; CHANGELOG.md has this release.

Settings #

• To do: settings/design.ini.append.php registers the design (DesignExtensions[]).
• To do: The theme does not set SiteDesign globally (The design settings a theme ships).
• To do: No password, key or token in any settings file; no settings/override/ in the theme.
• To do: Every own setting is commented.

Packaging #

• To do: composer validate passes; extra.ezpublish-legacy-extension-name names the folder.
• To do: A test install with Composer lands in the right folder and renders.
• To do: Bundled .ezpkg files validate and install on a test site.

Design quality #

• To do: Accessibility checklist passed (Checklist: accessibility).
• To do: No inline CSS or JavaScript; the CSP checklist passed (Checklist: CSP).
• To do: Light and dark mode, 200% zoom and a phone width checked (Checklist: dark mode).
• To do: Templates escape output (Checklist: code review for templates).

Repository #

• To do: git status --short is empty; nothing ignored has slipped in (A .gitignore for themes).
• To do: No customer names or personal data in demo data, screenshots or text.

When every box is ticked, continue with Checklist: before you publish.

Related pages #

• Troubleshooting theme extensions
• Checklist: theme launch
• Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.