on master help sign in
move sections in maintainer guide
4e8d545Harendra Kumar
MAINTAINING.md+14−13
@@ -13,19 +13,6 @@
13 * Check regressions from previous release
13 * Check regressions from previous release
14 * Check comparative benchmarks using streaming-benchmarks
14 * Check comparative benchmarks using streaming-benchmarks
15
15
16−* _Update changelog_:
17−
18− * Change the `Unreleased` section at the top of changelog file to the new
19− release version number and make an `Unreleased` section above it. Using
20− `Unreleased` instead of the next release number for unreleased changes is
21− important. If we use the next release number instead, then when adding a
22− new change to the changelog, at one look we cannot know whether the
23− release number on top is unreleased or released.
24−
25− * Make sure all the bug fixes being included in this release are marked
26− with a target release on github. So that users can search by release if
27− they want.
28−
29* _Update Package Metadata:_
16* _Update Package Metadata:_
30
17
31 * Update `stack.yaml` to latest stable resolver, cleanup extra-deps
18 * Update `stack.yaml` to latest stable resolver, cleanup extra-deps
@@ -33,6 +20,20 @@
33 * 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.
34 * Update `tested-with` field
21 * Update `tested-with` field
35 * Make sure all dependency bounds are correct
22 * Make sure all dependency bounds are correct
23+
24+* _Update changelog & Version_:
25+
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
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
35+ with a target release on github. So that users can search by release if
36+ they want.
36 * Bump the package version
37 * Bump the package version
37
38
38* _Upload_:
39* _Upload_: