summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess2014-10-31 11:08:51 -0400
committerJoey Hess2014-10-31 11:08:51 -0400
commit218574a4c46049de1e979a4d2aff3a9b31fbd966 (patch)
tree384319740e72d0ca922ca898ea5299169783d8ea /doc
parent4e070b4d7ff0e57a06e135228f539e3b2db398ea (diff)
parent65a0da97c3170fcea54eb8fd78885f802b3a8bc2 (diff)
Merge branch 'joeyconfig'
Diffstat (limited to 'doc')
-rw-r--r--doc/contributing.mdwn6
-rw-r--r--doc/interface_stability.mdwn13
2 files changed, 18 insertions, 1 deletions
diff --git a/doc/contributing.mdwn b/doc/contributing.mdwn
index 33b34a61..84aa5d64 100644
--- a/doc/contributing.mdwn
+++ b/doc/contributing.mdwn
@@ -3,7 +3,11 @@ modify and distribute it; indeed doing so is a fundamental part of how
propellor is configured and used.
You don't have to contribute your patches, but you're encouraged to do so;
-let's all make propellor awesome together! Patches can be sent to
+let's all make propellor awesome together! Also, contributing patches is a
+good way to make sure that your code keeps working in new versions of
+propellor. See [[interface_stability]].
+
+Patches can be sent to
<propellor@joeyh.name> or pull requests can be posted to [[todo]].
To certify that a change is released under propellor's BSD license,
diff --git a/doc/interface_stability.mdwn b/doc/interface_stability.mdwn
new file mode 100644
index 00000000..8ad5dfd8
--- /dev/null
+++ b/doc/interface_stability.mdwn
@@ -0,0 +1,13 @@
+Propellor is versioned using the Haskell [Package Version Policy](https://www.haskell.org/haskellwiki/Package_versioning_policy).
+
+This means that propellor 0.10.x contains some changes to its API;
+code written for propellor 0.9.x may need to be changed. Conversely,
+there are no breaking changes between 0.10.1 and 0.10.2.
+
+Whenever possible, breaking changes are made in a way that either changes a
+data type, or a function name, so that code that used the old API version
+won't compile under the new one.
+
+Sometimes, changes to the behavior of properties also merit a major version
+change. For example, propellor 0.8.0 completely revamped the privdata
+storage, and users had to manually transition.