danielsiepmann/tea
danielsiepmann/tea
1
0
mirror of https://github.com/FriendsOfTYPO3/tea.git synced 2024-11-23 21:36:13 +01:00
Code Activity
tea/README.md

59 lines
3.1 KiB
Markdown
Raw Normal View History

[TASK] Completely rewrite the README (#270)
2021-08-13 14:39:15 +02:00
# Example TYPO3 extension for code quality checks and automated tests
[TASK] Add a description to the README.
2013-11-01 19:51:50 +01:00
[FEATURE] Allow installations on TYPO3 12 (#652)
2022-10-19 09:06:36 +02:00
[![TYPO3 V12](https://img.shields.io/badge/TYPO3-12-orange.svg)](https://get.typo3.org/version/12)
[TASK] Update docs (#404) See https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/commit/c2bb63beadb7cc1ea6eb3496613c3376f970d4c9 for further details. The README.md should mostly only cover the abstract and links. The composer commands are the core value of this extension. List all commands in the documentation and copy the descriptions from the `composer.json`. This lets the global search at docs.typo3.org find these commands. Remove superfluous Linters page, which is integrated now in the Running page. Use sentence case in page titles in order to conform to the TYPO3 documentation standards. The ambiguous :ts: text role has been removed to not confuse the writer with typescript and typoscript. Add the common extension destinations to `composer.json`. (Packagist displays them in a prominent place.)
2022-04-12 19:00:11 +02:00
[![TYPO3 V11](https://img.shields.io/badge/TYPO3-11-orange.svg)](https://get.typo3.org/version/11)
[BUGFIX] Fix the license badge in the README (#633) Fixes #632
2022-10-15 18:08:12 +02:00
[![License](https://img.shields.io/github/license/TYPO3-Documentation/tea)](https://packagist.org/packages/ttn/tea)
[TASK] Reduce and reorder the badges in the README (#438) Reorder the badges so the TYPO3 versions come first and the CI information latest (ordered from user-relevant to developer-relevant). Drop some badges to get the badges to fit in one line again: - Drop the counter for this month's downloads (as this number fluctuated too much during the month). - Drop a duplicate badge. - Drop the badge for the old CoC (as we now are using the TYPO3 CoC). - Drop the "latest version" badge (as this tends to be unreliable).
2022-04-29 14:27:36 +02:00
[![Total downloads](https://poser.pugx.org/ttn/tea/downloads.svg)](https://packagist.org/packages/ttn/tea)
[BUGFIX] Fix the image URL of the CI status badge (#1495)
2024-10-26 17:20:29 +02:00
[![GitHub CI status](https://github.com/FriendsOfTYPO3/tea/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/FriendsOfTYPO3/tea/actions)
[TASK] Completely rewrite the README (#270)
2021-08-13 14:39:15 +02:00
[![GitLab CI status](https://gitlab.typo3.org/qa/example-extension/badges/main/pipeline.svg)](https://gitlab.typo3.org/qa/example-extension/-/pipelines)
[FEATURE] Use Coveralls for the code coverage (#425) Fixes #345 Closes #400
2022-04-15 18:47:18 +02:00
[![Coverage Status](https://coveralls.io/repos/github/TYPO3-Documentation/tea/badge.svg?branch=main)](https://coveralls.io/github/TYPO3-Documentation/tea?branch=main)
[TASK] Add a Flattr button
2016-02-08 19:10:41 +01:00
[TASK] Update docs (#404) See https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/commit/c2bb63beadb7cc1ea6eb3496613c3376f970d4c9 for further details. The README.md should mostly only cover the abstract and links. The composer commands are the core value of this extension. List all commands in the documentation and copy the descriptions from the `composer.json`. This lets the global search at docs.typo3.org find these commands. Remove superfluous Linters page, which is integrated now in the Running page. Use sentence case in page titles in order to conform to the TYPO3 documentation standards. The ambiguous :ts: text role has been removed to not confuse the writer with typescript and typoscript. Add the common extension destinations to `composer.json`. (Packagist displays them in a prominent place.)
2022-04-12 19:00:11 +02:00
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.
[FEATURE] Add an example for vfsStream
2015-10-24 01:16:37 +02:00
[TASK] Completely rewrite the README (#270)
2021-08-13 14:39:15 +02:00
You can also use this extension to manage your collection of delicious teas.
[FEATURE] Allow stand-alone tests
2017-05-05 18:00:40 +02:00
[TASK] Add Slack to README (#477) Resolves: #408
2022-07-13 18:23:06 +02:00
| | URL |
|------------------|----------------------------------------------------|
[TASK] Update repository urls (#946) Resolves: #895 Co-authored-by: Łukasz Uznański <l.uznanski@macopedia.com>
2023-10-08 21:53:41 +02:00
| **Repository:** | https://github.com/FriendsOfTYPO3/tea |
[TASK] Add Slack to README (#477) Resolves: #408
2022-07-13 18:23:06 +02:00
| **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 |
[TASK] Update docs (#404) See https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/commit/c2bb63beadb7cc1ea6eb3496613c3376f970d4c9 for further details. The README.md should mostly only cover the abstract and links. The composer commands are the core value of this extension. List all commands in the documentation and copy the descriptions from the `composer.json`. This lets the global search at docs.typo3.org find these commands. Remove superfluous Linters page, which is integrated now in the Running page. Use sentence case in page titles in order to conform to the TYPO3 documentation standards. The ambiguous :ts: text role has been removed to not confuse the writer with typescript and typoscript. Add the common extension destinations to `composer.json`. (Packagist displays them in a prominent place.)
2022-04-12 19:00:11 +02:00
[TASK] Add feedback section to readme (#1292) Communicate that we value and welcome feedback and the possible ways to provide feedback. Resolves: #1236
2024-05-07 15:22:21 +02:00
## 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).
[TASK] Rework how we solicate feedback (#1501) We have decided to no longer ask users to create GitHub issues for feedback as this doesn't work well with how we work. - drop the issue template for technical feedback - in the README, link to GitHub discussions instead of issues Fixes #1500
2024-10-29 16:55:43 +01:00
Another way is to create a [discussion on GitHub](https://github.com/FriendsOfTYPO3/tea/discussions).
[TASK] Add feedback section to readme (#1292) Communicate that we value and welcome feedback and the possible ways to provide feedback. Resolves: #1236
2024-05-07 15:22:21 +02:00
[TASK] Document philosophy of alignment with TYPO3 CMS Core (#1284) Resolves: #1237
2024-05-07 14:41:12 +02:00
## 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.
[TASK] Document that we follow semantic versioning (#1288) Resolves: #145
2024-05-07 14:49:50 +02:00
### Semantic Versioning
The project follows [Semantic Versioning](https://semver.org/).
[TASK] Document philosophy of alignment with TYPO3 CMS Core (#1284) Resolves: #1237
2024-05-07 14:41:12 +02:00
### 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/.
[TASK] Add the TYPO3 Online Days presentation to the README (#365)
2022-01-13 12:57:48 +01:00
## 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
[![cover slide](https://files.speakerdeck.com/presentations/e81870d463e84158afb9f93398ed062b/preview_slide_0.jpg?19017900)](https://speakerdeck.com/oliverklee/automating-the-code-quality-of-your-extensions)
### Video recording
[![video still](https://img.youtube.com/vi/_oe8ku2GM84/0.jpg)](https://youtu.be/_oe8ku2GM84?t=6983)
Copy permalink