cadey
/
propellor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add interface stability docs

This commit is contained in:
Joey Hess 2014-10-31 11:08:45 -04:00
parent 5b3a0d7026
commit 65a0da97c3
2 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/contributing.mdwn
View File

@ -3,7 +3,11 @@ modify and distribute it; indeed doing so is a fundamental part of how
propellor is configured and used. propellor is configured and used.
You don't have to contribute your patches, but you're encouraged to do so; 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]]. <propellor@joeyh.name> or pull requests can be posted to [[todo]].
To certify that a change is released under propellor's BSD license, To certify that a change is released under propellor's BSD license,

13
doc/interface_stability.mdwn Normal file
View File

@ -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.