Skip to content
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.

Sign up for GitHub

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

docs: add Backward Compatibility Notes #6418

Merged
merged 1 commit into from
Aug 25, 2022
Merged

docs: add Backward Compatibility Notes #6418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions user_guide_src/source/installation/backward_compatibility_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
############################
Backward Compatibility Notes
############################

We try to develop our products to be as backward compatible (BC) as possible.

Only major releases (such as 4.0, 5.0 etc.) are allowed to break backward compatibility.
Minor releases (such as 4.2, 4.3 etc.) may introduce new features, but must do so without breaking the existing API.

However, the code is not mature and bug fixes may break compatibility in minor releases, or even in patch releases (such as 4.2.5). In that case, all the breaking changes are described in the :doc:`../changelogs/index`.

*****************************
What are not Breaking Changes
*****************************

- System messages defined in **system/Language/en/** are strictly for internal framework use and are not covered by backwards compatibility (BC) promise. If developers are relying on language string output they should be checking it against the function call (``lang('...')``), not the content.
4 changes: 4 additions & 0 deletions user_guide_src/source/installation/upgrading.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,17 @@ Upgrading From a Previous Version
Please read the upgrade notes corresponding to the version you are
upgrading from.

See also :doc:`./backward_compatibility_notes`.

.. note:: If you don't know what version of CodeIgniter you are currently running,
you can get it from :ref:`the Debug Toolbar <the-debug-toolbar>`,
or simply echo the constant ``\CodeIgniter\CodeIgniter::CI_VERSION``.

.. toctree::
:titlesonly:

backward_compatibility_notes

upgrade_423
upgrade_422
upgrade_421
Expand Down