Skip to content

Commit fb578ad

Browse files
authored
Merge pull request #127 from spier/docs-explain-pattern-states
[docs] adding more explanation for Pattern Maturity and Review Steps.
2 parents a58cab3 + 4837877 commit fb578ad

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

meta/pattern-states.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
1-
# Potential new nomenclature
2-
Below shows updated nomenclature around the maturity and state that each pattern can be in. Each pattern is either less or more mature (has a solution or doesn't), and goes through a multi-step review process.
1+
# Pattern States (New Nomenclature)
32

4-
<img src="/assets/img/patterns-steps-and-maturities.png" height="350" style="float:right" align="right" alt="Maturity and Review Steps as seen on Github">
3+
Below shows the nomenclature around the maturity and state that each pattern can be in. Each pattern is either less or more mature (has a solution or doesn't), and goes through a multi-step review process.
4+
5+
<img src="/assets/img/patterns-steps-and-maturities.png" height="350" style="float:right" align="right" alt="Pattern Maturity and Review Steps as seen on Github">
56

67
## Pattern Maturity
8+
9+
Pattern Maturity describes what **state the Solution is in**. It gives the reader of these InnerSourcePatterns an idea how much they can trust the pattern.
10+
711
* A - Donut (Lacks Solution)
812
* B - Unproven (Ideas)
913
* C - Proven (Draft)
1014

1115
## Review Steps
16+
17+
The **Review Steps** refer to what needs to be done next in the review process. This keeps reviews on track and helps to move the patterns towards the next level of Pattern Maturity.
18+
1219
* 0 - Incomplete
1320
* 1 - Do 1st Review
1421
* 2 - Needs Revision
@@ -17,21 +24,28 @@ Below shows updated nomenclature around the maturity and state that each pattern
1724
* 5 - Accepted
1825

1926
## Examples
27+
28+
**Pattern Maturity** and **Review Steps** are used in combination. Therefore the [pull requests][pulls] on this repository often have two labels, one for the maturity of the solution, and one for the phase of the review the pattern is in.
29+
30+
Some examples to illustrate this:
31+
2032
* e.g., Donut pattern needing its 1st review
2133
* e.g., Unproven pattern that has been reviewed once and is in need of a revision
2234

23-
# Explanation of changes
35+
# Explanation of Changes (from 03/2017)
2436

2537
Context: Some of these fields were renamed from a prior version of our repository. The below describes the changes made.
2638

2739
I renamed it "Pattern Maturity", because this was formerly not clear to me what a 'Pattern Type' was. It did not speak to the fact that the 3 'types' were levels of how complete or mature the pattern is.
2840

2941
"Unproven" and "Proven" will take us getting used to, but they explain the maturity-level better than 'Idea' and 'Draft', which both can mean things not intended (Georg, Daniel, and I used them incorrectly multiple times). When these two states were explained on the head wiki page (now on README) it had in parenthesis that their difference was really how proven or unproven the solutions were. So, why not just use the explanation instead of words that can take on arbitrary meanings?
3042

31-
I kept "Donut" as I tried a couple meaningful names, but it just sounds too catchy/rememberable as Donut. It definetely needs an explanation next to it "(Lacks Solution)" wherever mentioned - when I was new I couldn't figure out the "donut" references.
43+
I kept "Donut" as I tried a couple meaningful names, but it just sounds too catchy/rememberable as Donut. It definitely needs an explanation next to it "(Lacks Solution)" wherever mentioned - when I was new I couldn't figure out the "donut" references.
3244

3345
The "Review Steps" refer to what needs to be done NEXT. This keeps reviews on track and knowing what comes next.
3446

35-
The numbering / order helps on Github to visualize and keep reviewers on track. The coloring also helps with visualization. [Go check it out live](https://github.com/InnerSourceCommons/InnerSourcePatterns/pulls)
47+
The numbering / order helps on GitHub to visualize and keep reviewers on track. The coloring also helps with visualization. [Go check it out live][pulls].
3648

3749
"Early Idea" tag is for Issues where very initial or place holder ideas can be placed. "Non-Pattern" can be used for meta Pull Requests such as edits to README.md.
50+
51+
[pulls]: https://github.com/InnerSourceCommons/InnerSourcePatterns/pulls

0 commit comments

Comments
 (0)