Skip to content

Commit c5a0409

Browse files
committed
📝 Create milestone guidelines.
1 parent c811290 commit c5a0409

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,24 @@ Templates should promote a high contribution quality by referring [contributing
9595

9696
## Milestone
9797

98+
A Milestone should correspond to a project delivery.
99+
Every GitHub issue should be assigned to a Milestone.
100+
101+
*Why*
102+
>Milestones allow to group issues and prioritize them. This can only be done inside a Milestone. It is recognized as a good practice to manage issues for your project inside a Milestone. Milestones allow you to follow overall progress based on closed/opened issues.
103+
104+
Every Milestone should have a due date.
105+
106+
*Why*
107+
>Milestones with no due date are reducing the team's productivity as it does not set a clear goal for the project.
108+
109+
A Milestone should only be closed when progress is at 100%, meaning that all issues and pull requests related to it are closed. If you do not consider an issue to be necessarily closed to finish your Milestone then it should be moved to another one.
110+
111+
*Why*
112+
>Milestones are often associated with a release of a project. It should be compulsory to have all issues done before releasing a new version of your project. Milestones are also a great way to create [Changelogs](#changelog) which requires to be consitent with Milestones management.
113+
114+
115+
98116
## Label
99117

100118
## CHANGELOG

0 commit comments

Comments
 (0)