TYPO3 Contributor Onboarding

July 13th, 2017 - Malmö/SE

Overview & Topics

• Introduction & Requirements
• TYPO3 Universe & Teams
• Tools & Communication
• TYPO3 CMS Releases
• Hands on!
• Anything else...

Ways to contribute

• report a bug & give feedback
• make a donation
• publish an extension
• translate an extension
• improve documentation
• contribute source code
• and much more ...

Scratch your own itch!

• bugs will not be solved by themselves
• only known bugs can be tackled
• without feedback, motivation gets lost
• community is about us - not they
• you can learn a lot
• … then, you can change a lot
• … then, you can tell a lot to others

You should have...

• development environment
• e.g. PhpStorm, Eclipse, ...
• local XAMP stack
• Apache web-server
• MySQL database (or MariaDB)
• PHP interpreter (5.5+ / 7.x)
• or Vagrant Box or Docker Container
• Git installation

Universe & Teams

TYPO3 Universe

TYPO3 Association

Expert Advisory Board

Business Control Committee

Board

TYPO3 Inc

Community

Core Team

Marketing Team

Server Team

Event Team

[…] Team

Certification Team

Documentation Team

Agencies

Members

TYPO3 Teams

Content & Publications

​

• Press Team
• Editorial Team
• Translation Team
• Documentation Team

Organize & Visualization

​

• Event Committee
• Certification Team
• Marketing Team
• Design Team

TYPO3 CMS Development

​

• Core Team
• Security Team
• Usability Team
• Server Team

TYPO3 Events

International Conferences

T3CON

Developer Days

T3DD

Snowboard Tour

T3BOARD

Agency Meet-Up Days

T3AMD

Barcamps

T3C[xyz]

Code Sprints

T3SPRINT

User Experience Week�T3UXW

User Groups, and a lot of more events

Tools & Communication

typo3.org

• central community hub
• announcements & events
• extensions & TYPO3 releases
• management of TYPO3 accounts
• register your account soon - you’ll need it

Slack

• central communication platform
• public & protected topic groups
• #typo3-cms - general CMS support
• #typo3-cms-coredev - join the core development
• direct messages to whole community
• get almost immediate feedback
• register at https://forger.typo3.org/slack

Mailing Lists - lists.typo3.org

• … from times prior to Slack
• not used that frequent anymore
• TYPO3-announce for important releases

Wiki Pages - wiki.typo3.org

• for ad-hoc documentation & reference
• e.g. https://wiki.typo3.org/Composer
• e.g. https://wiki.typo3.org/Autoload
• for discussing blueprints (concepts)
• provide a bigger picture to others
• ask for feedback & additions
• see https://wiki.typo3.org/Blueprints

Documentation - docs.typo3.org

• based on ReST (re-structured text)
• requires local Sphinx-Doc installation
• official core documentation
• TypoScript, TCA, system extensions ...
• extension documentation
• other documentation
• e.g. “rst-ing with PhpStorm”
• possibility to directly edit via GitHub

Translation - translation.typo3.org

• based on Pootle
• uses XLIFF standard
• collaborative translation tool
• for core & extensions

Forge - forge.typo3.org

• based on Redmine
• issue tracker for core & extensions
• search for existing bugs & patches
• provide feedback & further details
• new bug reports & feature requests

Git Repositories - git.typo3.org

• for core & some extensions
• used to fetch data only
• review process on a different system

Gerrit - review.typo3.org

• web-based code review system
• Git server & SSH server
• written in Java, initially by Google
• developed for Android development
• relies on Git as version control system
• gatekeeper for git.typo3.org repository

Gerrit - regular way & direct push

Gerrit - using the review system

Gerrit - why?

• software is always incomplete
• using feedback and skills of others
• four-eye review - two additional reviewers
• no merges without proper review
• except real no-brainers
• otherwise “you break it, you fix it”
• code review & functional verification

Gerrit - functional verification

• change really fixes described bug
• change really meets feature requirements
• robust & not breaking existing behavior
• does not introduce side effects
• ideally with automated test scenario
• individually test in browser
• think about the change & try to find flaws

Gerrit - code review

• change is correct & complete
• change is well-coded (no side-effects)
• change is documented (e.g. new feature)
• change follows coding guidelines
• review by reading the code
• review by understanding the code

Gerrit - voting & merging

• changes to TYPO3 CMS core require
• at least one vote by a team member (+2)
• at least one vote by a community member (+1)

GitHub - github.com/TYPO3

• for some core components
• additional semi-official core extensions
• like deprecated previous core extensions
• used as mirror for composer, Travis & others
• for many third party extensions
• instead of review.typo3.org?
• fine & easier for few contributors
• pull-requests as review workflow

​

Travis, AppVeyor & Bamboo

• continuous integration pre-/post-merge
• there are thousands of
• ~9000 unit tests - small specific parts
• ~800 functional tests - dependent processes
• ~60 acceptance tests - browser UI (Codeception)
• Travis CI - for Linux
• AppVeyor - fow Windows
• Bamboo - on own infrastructure

​

Forger - forger.typo3.org

• simplified search functionality
• aggregation & metrics for development
• open issues
• pending patches
• “almost there” changes
• historical measurements
• useful for sprint boards & overviews
• additional helper tools

Interaction Guidelines

• use English first (messages & coding)
• documentation helps others to understand
• be friendly and helpful - code of conduct
• give feedback & ask for feedback
• it’s a network - stay connected

TYPO3 CMS Releases

Releases & Versioning

• long term support versions (LTS)
• three years maintenance in total
• 1 year regular bug fixes
• 2 years priority & security bug fixes
• semantic versioning
• 7.x.y → 8.0.0 - major (breaking compatibility)
• 8.0.0 → 8.1.0 - minor (introducing new features)
• 8.1.1 → 8.1.2 - patch (just bug fixes)

Releases & Versioning

Development Process

• development of TYPO3 CMS 8
• sprint releases & specific focus (~6 weeks each)
• 8.0 → remove deprecated code
• 8.1 → Doctrine DBAL prerequisites
• 8.2 → Doctrine DBAL integration
• 8.3 → Rich Text Editor
• ...
• code sprints prior to each minor release
• development → stabilization → release

Development Guidelines

• coding guidelines & PSR-2 coding style
• code formatting & indentions
• directory structure & naming scheme
• PHPdoc comments for classes and methods
• commit message format
• [FEATURE] → introduce new behavior
• [SECURITY] → fixing a security issue
• [BUGFIX] → fixing a bug, non-breaking change
• [TASK] → “undefined”, e.g. code clean-up

Development Guidelines

• document important changes
• new features
• breaking changes
• important changes
• deprecation changes
• see ChangeLog

Hands on!

Configure Git & Gerrit

• registered at typo3.org already?
• follow contribution workflow guide
• creating SSH key-pair
• register & configure review.typo3.org account
• configure SSH, Git & Gerrit locally
• install Gerrit commit message hook
• test your settings

Review & test a change

• open https://review.typo3.org/#/c/48977/
• copy & use cherry-pick command
• git fetch� ssh://review.typo3.org/Packages/TYPO3.CMS� refs/changes/77/48977/1� && git cherry-pick FETCH_HEAD
• do code review & functional verification
• apply your vote or comment on Gerrit

Modify & push a change

• use previously cherry-picked change
• do any modification
• amend your changes
• git commit -a --amend
• push back your changes
• git push origin HEAD:refs/publish/master

Create a new change

• create, search, find an issue
• think about it and create a patch for it
• commit the change & add message
• git commit -a
• push your changes to Gerrit
• git push origin HEAD:refs/publish/master

Thanks!

Oliver Hader & Anja Leichsenring

Slack: @olly & @maddy

Twitter: @ohader & @maddy2101

Mail: oliver.hader@typo3.org &� anja.leichsenring@typo3.org

These slides are thankfully inspired by

Michael Stucki & Xavier Perseguers

Nicole Cores & Helmut Hummel