Contributing

Thanks for considering contributing to this extension! Since it is an open source product, its successful further development depends largely on improving and optimizing it together.

The development of this extension follows the official TYPO3 coding standards. To ensure the stability and cleanliness of the code, various code quality tools are used and most components are covered with test cases.

Create an issue first

Before you start working on the extension, please create an issue on GitHub: https://github.com/CPS-IT/handlebars/issues

Also, please check if there is already an issue on the topic you want to address.

Contribution workflow

Note

This extension follows Semantic Versioning.

Preparation

Clone the repository first:

git clone https://github.com/CPS-IT/handlebars.git
cd handlebars

Now install all Composer dependencies:

composer install

Check code quality

https://github.com/CPS-IT/handlebars/actions/workflows/cgl.yaml/badge.svg
# Run all linters
composer lint

# Run Composer normalization
composer lint:composer

# Run PHP linter only
composer lint:php

# Run TypoScript linter only
composer lint:typoscript

# Run PHP static code analysis
composer sca

Run tests

https://github.com/CPS-IT/handlebars/actions/workflows/tests.yaml/badge.svg https://codecov.io/gh/CPS-IT/handlebars/branch/develop/graph/badge.svg?token=6TDD6TVHQH
# Run tests
composer test

# Run tests with code coverage
composer test:ci

The code coverage reports will be stored in .Build/log/coverage.

Build documentation

# Rebuild and open documentation
composer docs

# Build documentation (from cache)
composer docs:build

# Open rendered documentation
composer docs:open

The built docs will be stored in .Build/docs.

Pull Request

When you have finished developing your contribution, simply submit a pull request on GitHub: https://github.com/CPS-IT/handlebars/pulls