Skip to content

Updated pattern maturity of patterns in markdown format#131

Merged
rrrutledge merged 4 commits intoInnerSourceCommons:masterfrom
spier:issues/128-review-pattern-maturity-declaration
Mar 18, 2020
Merged

Updated pattern maturity of patterns in markdown format#131
rrrutledge merged 4 commits intoInnerSourceCommons:masterfrom
spier:issues/128-review-pattern-maturity-declaration

Conversation

@spier
Copy link
Copy Markdown
Member

@spier spier commented Mar 18, 2020 •
edited
Loading

Fixes #128.

  • added/updated the "## Status" section for the patterns listed in README that are available as .md files
  • also ordered the sections according to the order in pattern-template.md.
  • fixed some minor typos too

Warning

Looks like my editor removed a bunch of spaces at the end of lines automatically?
I don't really know how that happened.

Unfortunately that makes the diff below a bit harder to read.

Other Observations

  • Prerequisites
    • found in: gig-marketplace.md, innersource-portal.md
    • not part of the Pattern template
  • "Solution"/"Solutions" / is used in singular and plural form in the patterns
  • "Author","Authors","Author(s)"
  • do we want newline after headlines in the .md files? Tiny difference admittedly :)
  • "Patlet" section was missing from some patterns. I added a placeholder for it. e.g. review-committee.md
  • sections that appear in some patterns but are not part of the Pattern template
    • See also
    • Related Patterns
    • Variants
    • Also Known As
  • having only one pattern in the folder "project-roles", while all other .md files are in the root folder is confusing

@spier
Updated all patterns in block "Reviewed Patterns (proven and reviewed)".
82061e3 
- Mostly added or update the "## Status" section for all patterns.
- also ordered the sections according to the order in `pattern-template.md`.
- fixed some minor typos too
@spier
Copy link
Copy Markdown
Member Author

spier commented Mar 18, 2020

@rrrutledge I am not done yet but I submitted this as a draft PR, so that you can see in which direction I am going with this.

Would you mind taking a look, so that I am not overdoing it?

rrrutledge
rrrutledge approved these changes Mar 18, 2020
View reviewed changes
Copy link
Copy Markdown
Contributor

@rrrutledge rrrutledge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!

@rrrutledge
Copy link
Copy Markdown
Contributor

rrrutledge commented Mar 18, 2020

Everything that is there looks good.

spier added 3 commits March 18, 2020 19:15
@spier
Updated patterns in block "Pattern Drafts (proven, not yet fully revi…
0e4f9a3 
…ewed)".

=> Maturity: Proven

Was actually just pattern `start-as-experiment.md`, as all other patterns in the block are still kept in gDocs, wiki, or open Pull Requests.
@spier
Updated patterns in block "Reviewed Pattern Ideas (not yet proven but…
3696df7 
… reviewed)"

=> Maturity: Unproven
@spier
fixing one tiny typo
96e631d
@spier spier marked this pull request as ready for review March 18, 2020 18:44
@spier
Copy link
Copy Markdown
Member Author

spier commented Mar 18, 2020

@rrrutledge I think that this is a good enough iteration i.e. I am happy with this to be merged, if you think the changes make sense.

@spier spier changed the title Updated all patterns in block "Reviewed Patterns (proven and reviewed)". Updated pattern maturity of patterns in markdown format Mar 18, 2020
This was referenced Mar 18, 2020
Closed
Merged
@rrrutledge rrrutledge merged commit a8ad8cd into InnerSourceCommons:master Mar 18, 2020
@spier spier deleted the issues/128-review-pattern-maturity-declaration branch March 19, 2020 06:05
@lenucksi lenucksi added 📖 Type - Content Work Working on contents is the main focus of this issue / PR Type - Maintenance / Cleanup Maintaining / cleaning the repo is the main focus of this issue / PR labels Sep 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rrrutledge rrrutledge rrrutledge approved these changes

Assignees

No one assigned

Labels

📖 Type - Content Work Working on contents is the main focus of this issue / PR Type - Maintenance / Cleanup Maintaining / cleaning the repo is the main focus of this issue / PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Pattern Maturity in patterns does not match defined pattern-states nomenclature

3 participants

@spier @rrrutledge @lenucksi