8000 added a note about experimental features · symfony/symfony-docs@4f7b7ea · GitHub
[go: up one dir, main page]

Skip to content

Commit 4f7b7ea

Browse files
committed
added a note about experimental features
1 parent ee31b7f commit 4f7b7ea

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

contributing/code/bc.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,14 @@ The second section, "Working on Symfony Code", is targeted at Symfony
3232
contributors. This section lists detailed rules that every contributor needs to
3333
follow to ensure smooth upgrades for our users.
3434

35+
.. warning::
36+
37+
Code marked with the ``@experimental`` or the ``@internal`` tags is
38+
excluded from our Backward Compatibility promise.
39+
40+
Also note that backward compatibility breaks are tolerated if they are
41+
required to fix a security issue.
42+
3543
Using Symfony Code
3644
------------------
3745

contributing/community/releases.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,10 @@ of Symfony to the next one.
150150
Whenever keeping backward compatibility is not possible, the feature, the
151151
enhancement or the bug fix will be scheduled for the next major version.
152152

153+
However, features marked with the ``@experimental`` tag are **not** part of the
154+
backward compatibility promise and their APIs can change from one minor version
155+
to the next. The changelog must explain the changes and how to upgrade.
156+
153157
Deprecations
154158
------------
155159

0 commit comments

Comments
 (0)
0