Basic principles and goals

[sypets]

1. Stable and robust (fix bugs before features)
2. Configurable and extendable
3. (Almost) zero configuration quickstart
4. clean code and test suite
5. User experience, fun to use

Explanations

about 1: Stable and robust (fix bugs before features)

Fix bugs before adding bells and whistles

about 2: Configurable and extendable

The extension should be configurable and extendable, but use defaults that will work well in most usecases.

about 3: (Almost) zero configuration quickstart

It should be possible to start without having to configure and setup a lot. Unfortunately, this is not entirely possible, but we try to use good defaults wherever possible, use the settings from global configuration (where available) and generate defaults.

about 4: Clean code and test suite

We adhere to TYPO3 core conventions as much as possible. This means we also enforce the TYPO3 coding guidelines, for example. Tools exist to check locally. For PR, GitHub actions run and perform the checks.

See CONTRIBUTING.md in this repo for more information, also see commands in composer.json and .github/workflows/ci.yaml.

For new features or bugfixes, tests should be added.

about 5: User experience, fun to use

It should be fun to use or at least a good experience. This means - wherever possible:

• intuitive to use.
• useful documentation
• nice graphics
• visualize results and show progress (what is happening?)
• feedback of achievements
• gamification?