-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
130 additions
and
201 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,95 +1,5 @@ | ||
# Contributing | ||
|
||
Thanks for considering contributing to this extension! :slightly_smiling_face: | ||
Please have a look in the [official documentation][1]. | ||
|
||
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](https://github.com/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](https://semver.org/).** | ||
|
||
### Preparation | ||
|
||
Clone the repository first: | ||
|
||
```bash | ||
git clone https://github.com/CPS-IT/handlebars.git | ||
cd handlebars | ||
``` | ||
|
||
Now install all Composer dependencies: | ||
|
||
```bash | ||
composer install | ||
``` | ||
|
||
### Check code quality | ||
|
||
[![CGL](https://github.com/CPS-IT/handlebars/actions/workflows/cgl.yaml/badge.svg)](https://github.com/CPS-IT/handlebars/actions/workflows/cgl.yaml) | ||
|
||
```bash | ||
# 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 | ||
|
||
[![Tests](https://github.com/CPS-IT/handlebars/actions/workflows/tests.yaml/badge.svg)](https://github.com/CPS-IT/handlebars/actions/workflows/tests.yaml) | ||
[![Coverage](https://codecov.io/gh/CPS-IT/handlebars/branch/develop/graph/badge.svg?token=6TDD6TVHQH)](https://codecov.io/gh/CPS-IT/handlebars) | ||
|
||
```bash | ||
# Run tests | ||
composer test | ||
|
||
# Run tests with code coverage | ||
composer test:coverage | ||
``` | ||
|
||
The code coverage reports will be stored in `.Build/log/coverage`. | ||
|
||
### Build documentation | ||
|
||
```bash | ||
# 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 | ||
[1]: https://docs.typo3.org/p/cpsit/typo3-handlebars/main/en-us/Contributing/Index.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,6 +29,4 @@ | |
* @author Elias Häußler <[email protected]> | ||
* @license GPL-2.0-or-later | ||
*/ | ||
final class TemplateCompilationException extends \RuntimeException | ||
{ | ||
} | ||
final class TemplateCompilationException extends \RuntimeException {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,6 +29,4 @@ | |
* @author Elias Häußler <[email protected]> | ||
* @license GPL-2.0-or-later | ||
*/ | ||
final class UnableToPresentException extends \RuntimeException | ||
{ | ||
} | ||
final class UnableToPresentException extends \RuntimeException {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,6 +29,4 @@ | |
* @author Elias Häußler <[email protected]> | ||
* @license GPL-2.0-or-later | ||
*/ | ||
interface HelperInterface | ||
{ | ||
} | ||
interface HelperInterface {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.