diff options
| author | Robert Collins <robertc@robertcollins.net> | 2014-08-31 22:11:22 +1200 |
|---|---|---|
| committer | Robert Collins <robertc@robertcollins.net> | 2014-08-31 22:11:22 +1200 |
| commit | 1b79d43282f4da67cf4fa25dbc78e7f99329ff12 (patch) | |
| tree | 3b00e45e333e9c3919f5de985a6684584168f406 /doc/hacking.rst | |
| parent | 5cc79a6a0460f398184182538807f6b6be1fa8f9 (diff) | |
| download | testtools-1b79d43282f4da67cf4fa25dbc78e7f99329ff12.tar.gz | |
Document backwards compatibility policy
Because post 1.0.0 software needs that.
Change-Id: I1802f0947f8b1027b71c75c41fb7c16aafb276ba
Diffstat (limited to 'doc/hacking.rst')
| -rw-r--r-- | doc/hacking.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/hacking.rst b/doc/hacking.rst index 73b5f12..ccfc155 100644 --- a/doc/hacking.rst +++ b/doc/hacking.rst @@ -130,6 +130,18 @@ including conformance with this HACKING file. Changes which all users should be made aware of should be documented in NEWS. +We are now in full backwards compatibility mode - no more releases < 1.0.0, and +breaking compatibility will require consensus on the testtools-dev mailing list. +Exactly what constitutes a backwards incompatible change is vague, but coarsely: + +* adding required arguments or required calls to something that used to work +* removing keyword or position arguments, removing methods, functions or modules +* changing behaviour someone may have reasonably depended on + +Some things are not compatibility issues: + +* changes to _ prefixed methods, functions, modules, packages. + NEWS management --------------- |