Quick Start: Get ready to contribute to TYPO3 in under 30 minutes!

This Tutorial / How To will show you the easiest and quickest way to become a contributor to TYPO3.

It is aimed at developers who have a good general knowledge, but need to know the specifics and rules of TYPO3 contributions.

We will use very brief wording and only few "read further" hints to streamline the process with conventions. Please check out the structure of this whole guide for more information.

These are the sections:

1. Prerequisites
  • OS: Windows WSL2, macOS, Linux
  • Docker environment (Podman, OrbStack, Colima works too)
  • DDEV
  • Terminal (Bash)
  • Git client
  • SSH client plus SSH key(s) and an email account
  • A PHP IDE of your choice (PhpStorm, Visual Studio Code, vi(m), ...)
2. Accounts

  • my.TYPO3.org, using SSO for:

    • Gerrit (Review System)
    • Forge (Redmine Issue Tracker)
  • (recommended) Slack (Chat)
3. Set up Git
  • Clone repository
  • Set up SSH key, Git hooks and push URL
4. Set up DDEV
  • Configure DDEV
  • Start Docker containers
5. Set up TYPO3
  • Install TYPO3
  • Enable EXT:styleguide
  • Launch TYPO3 Backend
6. Create a patch
  • Develop
  • Set up Forge issue
  • Commit and push to Gerrit
  • Work in Gerrit
  • Announce your contribution
  • Implement Feedback
  • Merge/abandon a patch
7. Contribute more!
  • Coordinate with the team
  • Cherry-picks and resetting
  • Reviewing other patches