CONTRIBUTING: Add changelog instructions (#462)
commitd8dafaea947f50c890a1b7327a058b4d08359d91
authorAdam Bergmark <adam@bergmark.nl>
dateTue 16 Aug 2016, 10:21 (10 years ago)
parenta41f2a6
CONTRIBUTING.md+14
@@ -1,3 +1,17 @@
1+# Documenting changes
2+
3+Changes that affect users of aeson should be mentioned in `changelog.md`. It should contain
4+* A description
5+* The level of change, see [PVP](https://wiki.haskell.org/Package_versioning_policy)
6+* Where applicable
7+ * How to migrate existing code
8+ * When it should be used
9+ * What it supersedes
10+
11+Add this entry under an `# Upcoming` header above existing releases.
12+
13+The exact format of entries is not important as we'll go through everything before a release is made.
14+
115# Style guide
216
317* 4 space indentation