8000 added a note about experimental features by fabpot · Pull Request #7419 · symfony/symfony-docs · GitHub
[go: up one dir, main page]

Skip to content

added a note about experimental features #7419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 17, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10000
9 changes: 9 additions & 0 deletions contributing/code/bc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,15 @@ The second section, "Working on Symfony Code", is targeted at Symfony
contributors. This section lists detailed rules that every contributor needs to
follow to ensure smooth upgrades for our users.

.. warning::

:doc:`Experimental Features </contributing/code/experimental>` and code
marked with the ``@internal`` tags are excluded from our Backward
Compatibility promise.

Also note that backward compatibility breaks are tolerated if they are
required to fix a security issue.

Using Symfony Code
------------------

Expand Down
23 changes: 23 additions & 0 deletions contributing/code/experimental.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Experimental Features
=====================

All Symfony features benefit from our :doc:`Backward Compatibility Promise
</contributing/code/bc>` to give developers the confidence to upgrade to new
versions safely and more often.

But sometimes, a new feature is controversial. Or finding a good API is not
easy. In such cases, we prefer to gather feedback from real-world usage, adapt
the API, or remove it altogether. Doing so is not possible with a no BC-break
approach.

To avoid being bound to our backward compatibility promise, such features can
be marked as **experimental** and their classes and methods must be marked with
the ``@experimental`` tag.

A feature can be marked as being experimental for only one minor version, and
can never be introduced in a :ref:`LTS version <releases-lts>`. The core team
can decide to extend the experimental period for another minor version on a
case by case basis.

To ease upgrading projects using experimental features, the changelog must
explain backward incompatible changes and explain how to upgrade code.
1 change: 1 addition & 0 deletions contributing/code/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Contributing Code
security
tests
bc
experimental
standards
conventions
git
Expand Down
5 changes: 5 additions & 0 deletions contributing/community/releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,11 @@ of Symfony to the next one.
Whenever keeping backward compatibility is not possible, the feature, the
enhancement or the bug fix will be scheduled for the next major version.

However, :doc:`Experimental Features </contributing/code/experimental>` are
**not** part of the backward compatibility promise and their APIs can change
from one minor version to the next. The changelog must explain the changes and
how to upgrade.

Deprecations
------------

Expand Down
0