Skip to content

oliverthiele/developer-guidelines

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 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

guidelines/

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

File Topics
xliff.md XLIFF 1.2 / 2.0 file format, attributes, source/translation conventions
typo3-developer.md TCA, Doctrine DBAL, Fluid — universal + links to version files
typo3-integrator.md TypoScript, translations — universal + links to version files
typo3/v13/developer.md v13-specific: Fluid 4 argument types
typo3/v13/integrator.md v13-specific: SiteSets, labels.xlf key naming
typo3/v14/developer.md v14-specific: Fluid 5 union types, FlexForm DS, TCA shortform
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, 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).

sitekit/

Architecture conventions specific to SiteKit-based TYPO3 extensions only. These rules do not apply to generic TYPO3 projects.

File Topics
sitekit/sitekit.md Layer model, template path abstraction, content element rendering

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: 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.


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

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors