Skip to content

Commit 5c8b782

Browse files
committed
Use preferred/not preferred pattern for milestone section.
1 parent c5a0409 commit 5c8b782

1 file changed

Lines changed: 52 additions & 10 deletions

File tree

README.md

Lines changed: 52 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -95,23 +95,65 @@ 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.
98+
Milestones should be based on iterative development and produce incremental builds. It enforces Agile methodology and promote continuous integration and deployment. It allows you to follow overall progress and create [changelogs](#changelog) based on opened/closed issues.
10099

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.
100+
### Incremental Title
103101

104-
Every Milestone should have a due date.
102+
Milestones should be described as increment based on software version.
105103

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.
104+
**Preferred:**
105+
```markdown
106+
Milestones:
107+
108+
- 1.1.0
109+
- 1.2.0
110+
- 1.3.0
111+
- 1.4.0
112+
```
113+
114+
**Not Preferred:**
115+
```markdown
116+
Milestones:
117+
118+
- Backlog
119+
- Ice Box
120+
- Release 1.0
121+
- Release 2.0
122+
```
123+
124+
*Pro tip*: when closing a milestone, a git tag using software version should be created.
125+
126+
### Short Iterative Due Date
127+
128+
**Milestones must have short due dates to define small increment** and 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 current milestone then it should be moved to another one.
129+
130+
**Preferred:**
131+
```markdown
132+
Milestones:
133+
134+
- 1.1.0 - Closed 4 weeks ago
135+
- 1.2.0 - Closed 2 weeks ago
136+
- 1.3.0 - Closed 1 day ago
137+
- 1.4.0 - Due by June 8, 2018
138+
```
139+
140+
**Not Preferred:**
141+
```markdown
142+
Milestones:
143+
144+
- Backlog - No due date
145+
- Ice Box - No due date
146+
- Version 1.0 - Due by September 1, 2019
147+
- Version 2.0 - Due by September 1, 2022
148+
```
108149

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.
150+
*Pro tip*: when closing a milestone, webhooks can be used to automatically create a release flow.
110151

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.
152+
### Github Issue And Pull Request Priority
113153

154+
Milestones should drive development for contributors and help them to focus on most priority issues and pull requests. Priorization should be based on comparaison and it's up to maintainers.
114155

156+
*Pro tip*: [labels](#label) should help maintainers to compare issues and pull requests easily.
115157

116158
## Label
117159

0 commit comments

Comments
 (0)