You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/devGuide/projectManagement.md
+10-20Lines changed: 10 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -22,13 +22,6 @@ For general best practices, refer to the guide [_Working with PRs_ @SE-EDU](http
22
22
23
23
***If the PR is very simple** (e.g. correcting a simple typo), one approval is sufficient for merging. Other PRs need two approvals.
24
24
25
-
***Once the first approval is given** from a developer, assign a version milestone to the PR (this is usually the next version, unless there is a justification for delaying the merging to future versions).
26
-
27
-
<boxtype="info"seamless>
28
-
29
-
**Note:** Should there be a subsequent rejection by other reviewers (or an error is spotted), the version milestone is removed immediately. The version milestone should only be restored once the new approvals come in.
30
-
</box>
31
-
32
25
***Once the second approval is given** from a ==senior developer== (or there are >= 3 approvals given from anyone), the PR can be merged immediately.<br>
33
26
If there is no second approval yet, wait for a day before merging the PR without the second approval.
34
27
@@ -67,7 +60,7 @@ For general best practices, refer to the guide [_Working with PRs_ @SE-EDU](http
67
60
68
61
<boxtype="info"seamless>
69
62
70
-
**Reason:** The release manager may not review all PRs, so please add the label to highlight the version impact of the PR. This helps to clarify which milestone the PR should be assigned to.
63
+
**Reason:** The release manager may not review all PRs, so please add the label to highlight the version impact of the PR.
71
64
</box>
72
65
73
66
1.**Draft the release note for breaking changes**.
@@ -77,13 +70,6 @@ For general best practices, refer to the guide [_Working with PRs_ @SE-EDU](http
77
70
**Reason:** The release manager may not have the full details of the PR, so please work with the PR author to prepare a release note (if applicable) in the PR description.
78
71
</box>
79
72
80
-
1.**Set a milestone** to the PR.
81
-
82
-
<boxtype="info"seamless>
83
-
84
-
**Reason:** We may have missed it during the "Approval" stage, so please add the version milestone if it is missing, so that the drafting of the release notes during the release process will be easier.
85
-
</box>
86
-
87
73
1. Tip: how to **undo an accidental merge commit.**
88
74
89
75
* In the event of a wrong commit strategy chosen, you can undo the merge to master by:
@@ -120,7 +106,7 @@ For general best practices, refer to the guide [_Working with PRs_ @SE-EDU](http
120
106
121
107
<boxtype="info"seamless>
122
108
123
-
* Double check that the PRs are correctly set to the milestone for the new version. Review the definition of [SEMVER](https://semver.org/) and the impact of the PRs.
109
+
* Double check that the PRs are appropriate for the new version. Review the definition of [SEMVER](https://semver.org/) and the impact of the PRs.
124
110
* We will specify updated version numbers exactly to ensure that each version will consistently fetch the same versioned internal packages.
125
111
* The end result of this command is version commit with an appropriate tag. We will make use of the generated tag and commit message later.
126
112
* Do not push this commit to the remote repository yet.
@@ -206,10 +192,6 @@ For general best practices, refer to the guide [_Working with PRs_ @SE-EDU](http
206
192
$ npm run deploy:ug
207
193
```
208
194
209
-
1.**Update milestones**. Close the [milestone on GitHub](https://github.com/MarkBind/markbind/milestones) and all issues in that milestone.
210
-
211
-
Also create a new milestone for the next iterations. Recommended to have at least two upcoming milestones opened. Use the format `vA.B.C` for the milestone title.
212
-
213
195
1.**Release on GitHub**.
214
196
215
197
a. Go to the MarkBind release page at https://github.com/MarkBind/markbind/releases.
@@ -380,5 +362,13 @@ Note that:
380
362
* Some time later: "@all-contributors please add tlylt for doc"
381
363
* Result: 'tlylt' will be updated to have both icons(code and doc)
Previously, we used milestones to help manage versions, adding a milestone to an issue once related PRs had been merged. However, there was confusion over the use of milestones and labels and adding a milestone was often forgotten. Hence, ultimately it was not sufficiently useful to the team.
0 commit comments