Work-Related/automated-typo3-update
Work-Related/automated-typo3-update
1
0
Code Issues Activity
automated-typo3-update/Documentation/source/contribution.rst
Daniel Siepmann 8cb68ff6bb
TASK: Migrate / write documentation 
* Add further information and sections, e.g. about contribution and
  extending.

Relates: #63
2017-04-13 10:54:32 +02:00

1.1 KiB
Raw Blame History

Contribution

The project is hosted at https://git.higidi.com/Automated-TYPO3-Update/automated-typo3-update fill issues there. Also you can fork and clone the project there and provide merge requests.

Also you can contact us on TYPO3 slack.

Documentation

Documentation is written using reStructuredText ans sphinx.

Just open the files with a text editor and update contents.

To render documentation locally install docker and run:

docker run -v "$PWD/Documentation":/sphinx danielsiepmann/sphinx

from within the project root.

Code

A .editorconfig is already provided to setup your editor. Also phpcs is configured, so make sure to check your coding style with phpcs.

New sniffs have to be covered by tests, see extending-tests.