Skip to content

Commit 5cef2cd

Browse files
spookylukeyfelixxm
authored andcommitted
Expanded API stability docs to include our policy of continual improvement.
1 parent f95b59a commit 5cef2cd

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

docs/misc/api-stability.txt

+17-8
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,21 @@
22
API stability
33
=============
44

5-
Django promises API stability and forwards-compatibility since version 1.0. In
6-
a nutshell, this means that code you develop against a version of Django will
7-
continue to work with future releases. You may need to make minor changes when
8-
upgrading the version of Django your project uses: see the "Backwards
9-
incompatible changes" section of the :doc:`release note </releases/index>` for
10-
the version or versions to which you are upgrading.
5+
Django is committed to API stability and forwards-compatibility. In a nutshell,
6+
this means that code you develop against a version of Django will continue to
7+
work with future releases. You may need to make minor changes when upgrading
8+
the version of Django your project uses: see the "Backwards incompatible
9+
changes" section of the :doc:`release note </releases/index>` for the version
10+
or versions to which you are upgrading.
11+
12+
At the same time as making API stability a very high priority, Django is also
13+
committed to continual improvement, along with aiming for "one way to do it"
14+
(eventually) in the APIs we provide. This means that when we discover clearly
15+
superior ways to do things, we will deprecate and eventually remove the old
16+
ways. Our aim is to provide a modern, dependable web framework of the highest
17+
quality that encourages best practices in all projects that use it. By using
18+
incremental improvements, we try to avoid both stagnation and large breaking
19+
upgrades.
1120

1221
What "stable" means
1322
===================
@@ -29,8 +38,8 @@ In this context, stable means:
2938
See :ref:`official-releases` for more details on how Django's version
3039
numbering scheme works, and how features will be deprecated.
3140

32-
- We'll only break backwards compatibility of these APIs if a bug or
33-
security hole makes it completely unavoidable.
41+
- We'll only break backwards compatibility of these APIs without a deprecation
42+
process if a bug or security hole makes it completely unavoidable.
3443

3544
Stable APIs
3645
===========

0 commit comments

Comments
 (0)