..  include:: /Includes.rst.txt
..  index:: ! Coding guidelines
..  _cgl:

=================
Coding guidelines
=================

This chapter contains description of the formal requirements or standards
regarding coding that you should adhere to when you develop TYPO3
extensions or Core parts.

.. tip::

   You can find an
   `.editorconfig <https://github.com/typo3/typo3/blob/main/.editorconfig>`__
   file in the TYPO3 Core  repository.
   `Some editors and IDEs <https://editorconfig.org/>`__ can use this
   file and the rules defined within.

Some basic rules are defined in the .editorconfig, such as the charset and
the indenting style. By default, indenting with 4 spaces is
used, but there are a few exceptions (e.g. for YAML or JSON
files).

For the files that are not specifically covered in the subchapters (e.g.
Fluid, .json, or .sql), the information in the .editorconfig file
should be sufficient.

..  toctree::
    :maxdepth: 1
    :titlesonly:

    Introduction
    PhpArchitecture/Index
    CglPhp/Index
    CodingBestPractices/Index
    CglJavaScript/Index
    CglTypeScript/Index
    CglTypoScript/Index
    CglTsConfig
    CglXliff/Index
    CglYaml
    CglRest/Index