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. In addition, we use DDEV for local development. Make sure to set it up as described below. For continuous integration, we use GitHub Actions.

Create an issue first

Before you start working on the extension, please create an issue on GitHub: https://github.com/eliashaeussler/typo3-solver/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/eliashaeussler/typo3-solver.git
cd typo3-solver

Now start DDEV:

ddev start

Next, install all dependencies:

ddev composer install
ddev frontend install

You can access the DDEV site at https://typo3-ext-solver.ddev.site/.

Check code quality

TYPO3

# All linters
ddev composer lint

# Specific linters
ddev composer lint:composer
ddev composer lint:editorconfig
ddev composer lint:php

# Fix all CGL issues
ddev composer fix

# Fix specific CGL issues
ddev composer fix:composer
ddev composer fix:editorconfig
ddev composer fix:php

# All static code analyzers
ddev composer sca

# Specific static code analyzers
ddev composer sca:php

Frontend

# All linters
ddev frontend run lint

# Specific linters
ddev frontend run lint:scss
ddev frontend run lint:ts

# Fix all CGL issues
ddev frontend run fix

# Fix specific CGL issues
ddev frontend run fix:scss
ddev frontend run fix:ts

Run tests

# All tests
ddev composer test

# Specific tests
ddev composer test:functional
ddev composer test:unit

# All tests with code coverage
ddev composer test:coverage

# Specific tests with code coverage
ddev composer test:coverage:functional
ddev composer test:coverage:unit

# Merge code coverage of all test suites
ddev composer test:coverage:merge

Code coverage reports are written to .build/coverage. You can open the last merged HTML report like follows:

open .build/coverage/html/_merged/index.html

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

Once you have finished your work, please submit a pull request and describe what you've done: https://github.com/eliashaeussler/typo3-solver/pulls

Ideally, your PR references an issue describing the problem you're trying to solve. All described code quality tools are automatically executed on each pull request for all currently supported PHP versions and TYPO3 versions.