Skip to content

Commit 8b268d8

Browse files
authored
Merge pull request #7 from ExcelsiorFamily/define-milestone-guidelines
Define guidelines for milestones management
2 parents 3ef92f0 + a0e81b9 commit 8b268d8

1 file changed

Lines changed: 63 additions & 0 deletions

File tree

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ These guidelines are based on [Building a strong community Github documentation]
1111
* [Issue & Pull Request Expectation](#issue--pull-request-expectation)
1212
* [Promoting A High Contribution Quality](#promoting-a-high-contribution-quality)
1313
* [Milestone](#milestone)
14+
* [Incremental Title](#incremental-title)
15+
* [Short Iterative Due Date](#short-iterative-due-date)
16+
* [Github Issue And Pull Request Priority](#github-issue-and-pull-request-priority)
1417
* [Label](#label)
1518
* [CHANGELOG](#changelog)
1619
* [CONTRIBUTING.md](#contributingmd)
@@ -95,6 +98,66 @@ Templates should promote a high contribution quality by referring [contributing
9598

9699
## Milestone
97100

101+
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.
102+
103+
### Incremental Title
104+
105+
Milestones should be described as increment based on software version.
106+
107+
**Preferred:**
108+
```markdown
109+
Milestones:
110+
111+
- 1.1.0
112+
- 1.2.0
113+
- 1.3.0
114+
- 1.4.0
115+
```
116+
117+
**Not Preferred:**
118+
```markdown
119+
Milestones:
120+
121+
- Backlog
122+
- Ice Box
123+
- Release 1.0
124+
- Release 2.0
125+
```
126+
127+
*Pro tip*: when closing a milestone, a git tag using software version should be created.
128+
129+
### Short Iterative Due Date
130+
131+
**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.
132+
133+
**Preferred:**
134+
```markdown
135+
Milestones:
136+
137+
- 1.1.0 - Closed 4 weeks ago
138+
- 1.2.0 - Closed 2 weeks ago
139+
- 1.3.0 - Closed 1 day ago
140+
- 1.4.0 - Due by June 8, 2018
141+
```
142+
143+
**Not Preferred:**
144+
```markdown
145+
Milestones:
146+
147+
- Backlog - No due date
148+
- Ice Box - No due date
149+
- Version 1.0 - Due by September 1, 2019
150+
- Version 2.0 - Due by September 1, 2022
151+
```
152+
153+
*Pro tip*: when closing a milestone, webhooks can be used to automatically create a release flow.
154+
155+
### Github Issue And Pull Request Priority
156+
157+
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.
158+
159+
*Pro tip*: [labels](#label) should help maintainers to compare issues and pull requests easily.
160+
98161
## Label
99162

100163
Labels should help contributors and reviewers to evaluate effort for a specific issue or pull request.

0 commit comments

Comments
 (0)