on master help sign in
update change tracking, planning
commit398022e784d1437b215c0ef0f128b79b62d5f85e authorHarendra Kumar <harendra.kumar@gmail.com> dateFri 23 Mar 2018, 19:30 (9 years ago) parent6c157b4
1 file changed+25−5
MAINTAINING.md+25−5
MAINTAINING.md+25−5
@@ -67,11 +67,6 @@ Note that if you are making a big feature change you may have a single issue
6767for that feature and attach many commits with it. So you do not necessarily
6868need to have an issue for each commit.
6969
70−Every new issue that requires a fix MAY be marked with a target release. But
71−remember that before we make a new release EVERY issue with a commit included
72−in that release that affects the end user MUST have the target release
73−correctly set.
74−
7570### Maintenance Changes
7671
7772Commits that do not impact the end user in any way are not required to have a
@@ -84,6 +79,31 @@ following:
8479* wontfix
8580* maintenance
8681
82+### Planning and Tracking Changes
83+
84+For planning purposes, open issues may be marked with milestones or target
85+releases. However, it may not always be known which release a fix will finally
86+land in. For example, we may decide to make a minor release instead of a major
87+one if there are no breaking changes yet, so we may not always know what would
88+be the next release version.
89+
90+Trackability means that we should be able to find which issues got fixed in
91+which release. Or what all issues got fixed in a particular release. We track
92+significant changes using the changelog. However, there may be more changes
93+that can only be tracked via issues, PRs or commits. When we make a release we
94+can mark all the issues fixed in that release with a correct release target for
95+future trackability.
96+
97+For better trackability of which issue got fixed in which release we need the
98+following:
99+
100+* Before you close an issue make sure a commit or a PR fixing the issue is
101+ attached with it. In the commit message you can reference an issue like
102+ "fixes #50", you can do the same in a PR as well.
103+* Before we make a new release EVERY issue with a commit included in that
104+ release that affects the end user, especially bugs and breaking changes MUST
105+ have the target release correctly set.
106+
87107### Changelog Management
88108
89109Keep the unreleased changes in the `Unreleased` section at the top of changelog