Skip to content

Commit

Permalink
Merge branch 'release/0.7.25'
Browse files Browse the repository at this point in the history
  • Loading branch information
eliashaeussler committed Oct 2, 2023
2 parents 94eaff8 + f20c1f1 commit f54337d
Show file tree
Hide file tree
Showing 11 changed files with 130 additions and 201 deletions.
94 changes: 2 additions & 92 deletions CONTRIBUTING.md
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
4 changes: 1 addition & 3 deletions Classes/Exception/TemplateCompilationException.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 {}
4 changes: 1 addition & 3 deletions Classes/Exception/UnableToPresentException.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 {}
4 changes: 1 addition & 3 deletions Classes/Renderer/Helper/HelperInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,4 @@
* @author Elias Häußler <[email protected]>
* @license GPL-2.0-or-later
*/
interface HelperInterface
{
}
interface HelperInterface {}
20 changes: 14 additions & 6 deletions Documentation/Contributing/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,18 +69,26 @@ Check code quality
# Run all linters
composer lint
# Run Composer normalization
# Run specific linters
composer lint:composer
# Run PHP linter only
composer lint:editorconfig
composer lint:php
# Run TypoScript linter only
composer lint:typoscript
# Run PHP static code analysis
# Fix all CGL issues
composer fix
# Fix specific CGL issues
composer fix:composer
composer fix:editorconfig
composer fix:php
# Run all static code analyzers
composer sca
# Run specific static code analyzers
composer sca:php
.. _run-tests:

Run tests
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Settings.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[general]
project = Handlebars
release = 0.7.24
release = 0.7.25
copyright = since 2020 by coding. powerful. systems. CPS GmbH
author = Elias Häußler

Expand Down
2 changes: 1 addition & 1 deletion Resources/Private/Libs/Build/composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 11 additions & 3 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -88,15 +88,23 @@
"docs:build": "docker-compose run --rm docs",
"docs:cleanup": "rm -rf .Build/docs",
"docs:open": "open .Build/docs/Result/project/0.0.0/Index.html",
"fix": [
"@fix:composer",
"@fix:editorconfig",
"@fix:php"
],
"fix:composer": "@composer normalize",
"fix:editorconfig": "@lint:editorconfig --fix",
"fix:php": "php-cs-fixer fix",
"lint": [
"@lint:composer",
"@lint:editorconfig",
"@lint:php",
"@lint:typoscript"
],
"lint:composer": "@composer normalize",
"lint:editorconfig": "ec --fix -e .Build",
"lint:php": "php-cs-fixer fix",
"lint:composer": "@fix:composer --dry-run",
"lint:editorconfig": "ec -e .Build",
"lint:php": "@fix:php --dry-run",
"lint:typoscript": "typoscript-lint -c typoscript-lint.yml",
"migration": [
"@migration:rector"
Expand Down
Loading

0 comments on commit f54337d

Please sign in to comment.