p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Expanded API stability docs to include our policy of continual improvement.

This commit is contained in:
Luke Plant 2019-11-15 22:06:33 +03:00 committed by Mariusz Felisiak
parent f95b59a1b3
commit 5cef2cd4a1
1 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/misc/api-stability.txt
View File

@ -2,12 +2,21 @@
API stability API stability
============= =============
Django promises API stability and forwards-compatibility since version 1.0. In Django is committed to API stability and forwards-compatibility. In a nutshell,
a nutshell, this means that code you develop against a version of Django will this means that code you develop against a version of Django will continue to
continue to work with future releases. You may need to make minor changes when work with future releases. You may need to make minor changes when upgrading
upgrading the version of Django your project uses: see the "Backwards the version of Django your project uses: see the "Backwards incompatible
incompatible changes" section of the :doc:`release note </releases/index>` for changes" section of the :doc:`release note </releases/index>` for the version
the version or versions to which you are upgrading. or versions to which you are upgrading.
At the same time as making API stability a very high priority, Django is also
committed to continual improvement, along with aiming for "one way to do it"
(eventually) in the APIs we provide. This means that when we discover clearly
superior ways to do things, we will deprecate and eventually remove the old
ways. Our aim is to provide a modern, dependable web framework of the highest
quality that encourages best practices in all projects that use it. By using
incremental improvements, we try to avoid both stagnation and large breaking
upgrades.
What "stable" means What "stable" means
=================== ===================
@ -29,8 +38,8 @@ In this context, stable means:
See :ref:`official-releases` for more details on how Django's version See :ref:`official-releases` for more details on how Django's version
numbering scheme works, and how features will be deprecated. numbering scheme works, and how features will be deprecated.
- We'll only break backwards compatibility of these APIs if a bug or - We'll only break backwards compatibility of these APIs without a deprecation
security hole makes it completely unavoidable. process if a bug or security hole makes it completely unavoidable.
Stable APIs Stable APIs
=========== ===========