Introduction

This guide provides all necessary information to enable you to contribute to the TYPO3 source code.

The main focus is submitting patches (to fix bugs or add new features) to the TYPO3 source code, but you will also find information for writing bug reports, adding documentation, running tests, reviewing and testing patches etc.

How this guide is structured

The guide is structured in a way to give you all necessary information in the order that you need it. This means you can read it from the beginning and use it as a hands on guide, performing the steps as you go along.

The further you go along, the more advanced the topics will become.

But, you can also use it as a reference guide and jump straight to a section you are looking for. In this case, use the search box to search for what you are looking for or browse through the menu.

Some pages near the end of the manual assume that you are already familiar with contributing and serve as reference pages, for example the git cheat sheet or the Quickstart: Creating a patch page for a terse overview of all steps involved in creating a patch.

Some of the information, that is too extensive for the main guide, is found in the Appendix.

Additional information

In general: If you wish to make a contribution, familiarize yourself with the basics and general conventions used. For the TYPO3 source it is mandatory that your code must follow the general coding guidelines for the project and that your commit messages follow the commit messages rules.

When developing, you will also want to be well informed about the latest developments in the TYPO3 core. For additional information, look here:

Other ways to contribute

Besides developing for the TYPO3 core, there are many other ways to contribute and help the TYPO3 community.

You can find general information here:

How to help in improving this guide

If you find a bug in this manual, please be so kind as to check the online version on https://docs.typo3.org/typo3cms/ContributionWorkflowGuide/. From there you can hit the "Edit me on GitHub" button in the top right corner and submit a pull request via GitHub. Alternatively you can just report an issue on Github.

Maintaining high quality documentation requires time and effort and the TYPO3 Documentation Team always appreciates support. If you want to support us, please join the slack channel #typo3-documentation.

Have a look at the contribution page for more information about how to contribute to the TYPO3 documentation: https://docs.typo3.org/Contribute/Index.html

And finally, as a last resort, you can get in touch with the documentation team by mail.