on master help sign in
reorganize changelog section
6c157b4Harendra Kumar
MAINTAINING.md+11−8
@@ -19,18 +19,12 @@
19 * Make sure the description in cabal file is in sync with README and other docs
19 * Make sure the description in cabal file is in sync with README and other docs
20 * Make sure CI configs include last three major releases of GHC in CI testing.
20 * Make sure CI configs include last three major releases of GHC in CI testing.
21 * Update `tested-with` field
21 * Update `tested-with` field
22− * Make sure all dependency bounds are correct
22+ * Make sure all dependency bounds can use latest versions
23
23
24* _Update changelog & Version_:
24* _Update changelog & Version_:
25
25
26 * Change the `Unreleased` section at the top of changelog file to the new
26 * Change the `Unreleased` section at the top of changelog file to the new
27− release version number. Using `Unreleased` instead of the next release
27+ release version number.
28− number for unreleased changes is important. First, we do not know the
29− next release number in advance, it could be a major or minor release.
30− Second, if we use the next release number instead, then when adding a new
31− change to the changelog, at one look we cannot know whether the release
32− number on top is unreleased or released.
33−
34 * Make sure all the bug fixes being included in this release are marked
28 * Make sure all the bug fixes being included in this release are marked
35 with a target release on github. So that users can search by release if
29 with a target release on github. So that users can search by release if
36 they want.
30 they want.
@@ -90,6 +84,15 @@ following:
90* wontfix
84* wontfix
91* maintenance
85* maintenance
92
86
87+### Changelog Management
88+
89+Keep the unreleased changes in the `Unreleased` section at the top of changelog
90+file. Using `Unreleased` instead of the next release number for unreleased
91+changes is important. First, we do not know the next release number in advance,
92+it could be a major or minor release. Second, if we use the next release
93+number instead, then when adding a new change to the changelog, at one look we
94+cannot know whether the release number on top is unreleased or released.
95+
93## TODO
96## TODO
94
97
95* GPG signed releases and tags
98* GPG signed releases and tags