Skip to content

Commit d2dc58e

Browse files
authored
Remove milestones from our project workflow docs (#2537)
1 parent aee7efc commit d2dc58e

File tree

1 file changed

+10
-20
lines changed

1 file changed

+10
-20
lines changed

docs/devGuide/projectManagement.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,6 @@ For general best practices, refer to the guide [_Working with PRs_ @SE-EDU](http
2222

2323
* **If the PR is very simple** (e.g. correcting a simple typo), one approval is sufficient for merging. Other PRs need two approvals.
2424

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-
<box type="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-
3225
* **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>
3326
If there is no second approval yet, wait for a day before merging the PR without the second approval.
3427

@@ -67,7 +60,7 @@ For general best practices, refer to the guide [_Working with PRs_ @SE-EDU](http
6760

6861
<box type="info" seamless>
6962

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.
7164
</box>
7265

7366
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
7770
**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.
7871
</box>
7972

80-
1. **Set a milestone** to the PR.
81-
82-
<box type="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-
8773
1. Tip: how to **undo an accidental merge commit.**
8874

8975
* 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
120106

121107
<box type="info" seamless>
122108

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.
124110
* We will specify updated version numbers exactly to ensure that each version will consistently fetch the same versioned internal packages.
125111
* 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.
126112
* 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
206192
$ npm run deploy:ug
207193
```
208194

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-
213195
1. **Release on GitHub**.
214196

215197
a. Go to the MarkBind release page at https://github.com/MarkBind/markbind/releases.
@@ -380,5 +362,13 @@ Note that:
380362
* Some time later: "@all-contributors please add tlylt for doc"
381363
* Result: 'tlylt' will be updated to have both icons(code and doc)
382364

365+
366+
## Other Notes
367+
368+
<box type="info" icon=":fas-question:" icon-color="info" seamless header='About Milestones'>
369+
370+
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.
371+
</box>
372+
383373
{% from "njk/common.njk" import previous_next %}
384374
{{ previous_next('githubActions/workflowSecurity', 'styleGuides') }}

0 commit comments

Comments
 (0)