Skip to content

Commit

Permalink
adding @experimental to classes
Browse files Browse the repository at this point in the history
  • Loading branch information
ArtificialOwl committed Oct 30, 2024
1 parent 9fb0aa7 commit 50d12d5
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions developer_manual/digging_deeper/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,13 @@ PHP testing API
To avoid releasing incomplete public API, it is possible to release a
testing version of the future API in the NCT namespace, following these rules:

- An API can only live in this testing namespace for one major release,
- Once tested, the API will be removed entirely or moved to the OCP public namespace,
- If the API is not removed, the version from the NCT namespace will be marked as deprecated,
- Deprecated API from the NCT namespace are kept for 2 major releases,
- Code quality, comments, tests and psalm check are expected to be identical to the OCP namespace.
- Classes must be tag as `@experimental`, including the current version of Nextcloud.
- An API can only live in this testing namespace for one major release.
- During this testing phase, the code and the API can be modified/restructured without limitation.
- Once tested, the API will be removed entirely or copied to the OCP public namespace.
- If the API is not removed, the version from the NCT namespace will be marked as deprecated.
- Deprecated API from the NCT namespace are kept for 2 major releases.

.. note::
- API within the testing namespace might not have documentation other than in-code comments.

0 comments on commit 50d12d5

Please sign in to comment.