Acceptance as a Playground Project

For a module to be accepted into the Qt project's playground we require

• A defined scope for the project,
• A responsible person/maintainer and
• A commitment to follow Qt coding guidelines and project structure.

TODO: what happens when it's accepted ? Where is the playground ?

Entering Technical Preview

Here are the criteria for a module to be added to the main Qt project as technical preview modules (first proposed in [0]):

• The module solves a problem our users have - It either implements new and so far non existent functionality - Or it solves an existing problem in a new and better way (and is intended to replace the old functionality over time)

• The module builds inside the Qt build system on all platforms

  • Compilation could be disabled on some platforms, but is not allowed to break any platform we support

• The module is CI controlled
• There is a decent set of automated tests covering the main functionality and most of the API of the module - The tests pass on all platforms where the module is supported
• APIs have been reviewed, and we are reasonably satisfied with them (we've done larger changes to APIs after TPs before)
• Architecture makes sense
• It follows the Qt coding style and conventions
• Implementation has been checked for sanity - It's ok to have parts that are flagged as needing further work (those have to be fixed before moving from TP to supported state)

A module accepted into technical preview shall be added to one of the Qt project's released supermodules, with status set to preview in its section of the supermodule's .gitmodules file. A technical preview module makes no promise of source compatibility or binary compatibility between versions.

Becoming a Maintained Module

TODO: what are the prerequisites for this ?

Once a module is accepted as a maintained module, its entry in its supermodule's .gitignore file is updated to a status that reflects its role. Maintained modules are part of regular Qt releases and are required to live up to the standard source- and binary-compatibility promises that the Qt project makes to its users.

References