mirror of
https://github.com/FriendsOfTYPO3/tea.git
synced 2025-03-18 04:03:50 +01:00
57 lines
3.1 KiB
Markdown
57 lines
3.1 KiB
Markdown
# Example TYPO3 extension for code quality checks and automated tests
|
|
|
|
[](https://get.typo3.org/version/12)
|
|
[](https://packagist.org/packages/ttn/tea)
|
|
[](https://packagist.org/packages/ttn/tea)
|
|
[](https://github.com/TYPO3BestPractices/tea/actions)
|
|
[](https://gitlab.typo3.org/qa/example-extension/-/pipelines)
|
|
[](https://coveralls.io/github/TYPO3-Documentation/tea?branch=main)
|
|
|
|
This TYPO3 extension, based on Extbase and Fluid, is an example of best
|
|
practices in automated code checks, unit/functional/acceptance testing and
|
|
continuous integration.
|
|
|
|
You can also use this extension to manage your collection of delicious teas.
|
|
|
|
| | URL |
|
|
|------------------|----------------------------------------------------|
|
|
| **Repository:** | https://github.com/TYPO3BestPractices/tea |
|
|
| **Read online:** | https://docs.typo3.org/p/ttn/tea/main/en-us/ |
|
|
| **TER:** | https://extensions.typo3.org/extension/tea/ |
|
|
| **Slack:** | https://typo3.slack.com/channels/qa-best-practices |
|
|
|
|
## Feedback
|
|
|
|
We value and welcome feedback of all kinds, including discussions.
|
|
Feedback can be sent via TYPO3 slack within [our channel](https://app.slack.com/client/T024TUMLZ/CSQ8T0VS5) or via direct massages to the team members.
|
|
We also welcome email. All the contact information is available at our [typo3.org team page](https://typo3.org/community/teams/best-practices).
|
|
Another way is to create a [discussion on GitHub](https://github.com/TYPO3BestPractices/tea/discussions).
|
|
|
|
## Philosophies
|
|
|
|
The following is a list of our code and technical philosophies only.
|
|
https://typo3.org/community/teams/best-practices provides an overview on how we work in general.
|
|
|
|
### Semantic Versioning
|
|
|
|
The project follows [Semantic Versioning](https://semver.org/).
|
|
|
|
### Align with TYPO3 core
|
|
|
|
We align all decisions with the TYPO3 core, whenever applicable.
|
|
TYPO3 itself is a mono repository and sometimes needs to make different decisions.
|
|
We document all divergences within Documentation/DivergencesToTypo3Core/.
|
|
|
|
## Presentation at the TYPO3 Online Days 2021
|
|
|
|
At the TYPO3 Online Days 2021, [Oliver Klee](https://www.oliverklee.de/) held a
|
|
session where her presented our approach for automating the code quality of
|
|
extensions.
|
|
|
|
### Slides
|
|
|
|
[](https://speakerdeck.com/oliverklee/automating-the-code-quality-of-your-extensions)
|
|
|
|
### Video recording
|
|
|
|
[](https://youtu.be/_oe8ku2GM84?t=6983)
|