Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Oliver Thiele — Developer Guidelines

Personal coding guidelines for PHP/TYPO3 projects.

Published primarily for developers who collaborate with me on projects — the rules here reflect how I structure, name, and maintain code across all my work.


Contents

AGENTS.md

Entry point for AI coding assistants: read order, and what to do when a rule is missing. See AGENTS.md.

guidelines/

Technology- and topic-specific coding guidelines that apply to all projects.

File Topics
typo3/ TYPO3 topic root — index and version model
typo3/integrator.md TypoScript, SiteSets, CE wizard, backend configuration
typo3/developer.md PHP, TCA, Fluid, Doctrine DBAL, views
typo3/content-blocks.md Content Block structure, portable assets, two-layer CSS, config.yaml
typo3/sitekit.md SiteKit layer model, template path abstraction (SiteKit projects only)
typo3/practices/ decision guides: which approach, and when deliberately not
typo3/versions.md which rule applies to which TYPO3 version
typo3/changelog-index/ every core changelog entry — grep only, never read whole
xliff/ XLIFF 1.2 / 2.0 file format, attributes, ICU message format
xliff/keys.md Key naming conventions, key lifecycle
xliff/typo3.md LLL references, SiteSet labels.xlf, enum label localization
php.md Naming conventions, PHPStan, PHP CS Fixer, type safety
testing.md Quality checks, execution order, PHPUnit, Playwright
git.md Branching workflow, commit messages, release process
scss.md Bootstrap-first, CUBE CSS, prefix system, custom properties, state classes
javascript.md data-js hooks, Bootstrap JS, ID conventions, framework choice
vue.md Component syntax, script setup, state management, when to use Vue
playwright.md Playwright test patterns, visual regression, functional tests, helpers
documentation.md README.md and CHANGELOG.md structure for Packagist extensions

See guidelines/README.md for shared rules that cut across all files (naming, formatting, tooling).

Changes between releases are documented in CHANGELOG.md.

skills/

Claude Code skills that work with these guidelines. They live in this repository because they depend on its structure and must stay in sync with it.

File Topics
typo3-changelog-harvest Build and query the TYPO3 changelog index
changelog-audit Find changelog entries the guidelines should react to, with a triage log
guidelines-upgrade Update a project's guideline references after a restructuring, and check permissions
create-content-block Scaffold a TYPO3 Content Block following the shared conventions

See skills/README.md for installation.


How to use

As a developer working with me: Load the relevant guideline file(s) for the area you are working in and follow the rules as written. When in doubt, prefer the existing project pattern over introducing a new one.

As an AI assistant: Start with AGENTS.md. Load only the files relevant to the current task. Follow rules strictly — do not reinterpret or override them based on general conventions. The guidelines take precedence over defaults. When a rule is missing, look it up or ask — never invent a fallback.


License

These guidelines are published for reference and collaboration. Feel free to adapt them for your own projects.

About

Opinionated coding guidelines for PHP/TYPO3 and frontend development. Covers naming conventions, formatting, Git workflow, SCSS, JavaScript, Vue, XLIFF, and documentation standards. Used as AI assistant context and developer reference.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages