Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Script to find upgradeable patterns #534

Merged
merged 7 commits into from
May 12, 2023
Merged

Script to find upgradeable patterns #534

merged 7 commits into from
May 12, 2023

Conversation

spier
Copy link
Member

@spier spier commented Mar 21, 2023

In a previous Board report we had discussed a plan to level up as many L1 pattern as possible to L2, to give them exposure to a wider audience (as the L2 patterns are published in our book).

To get a more reliable way to identify these patters, I wrote a script to find upgradeable patterns based on their number of Known Instances.

Warning: The number of Known Instances are only one of the requirement for our patterns to reach the next level.
Therefore running the script alone is not enough. Reading the pattern and the level requirements in detail is still required to decide whether or not a pattern can be pushed to the next level.

Main implementation steps:

  • /meta/scripts/find_upgradeable_patterns.rb - Script to identify upgradeable patterns based on their number of Known Instances
  • Formatting changes to the 'Known Instances' section of some patterns. Allows for easier scanning of the new find_upgradeable_patterns.rb script. (the script expects a bullet list of company names)

@spier
Copy link
Member Author

spier commented Mar 21, 2023

@robtuley as we discussed the topic of "upgradeable patterns" as part of a previous Board report, you may find this interesting.

This is the output of the script explained above:

$ ruby find_upgradeable_patterns.rb

## Initial => Structured
## 1-Initial patterns primed for upgrade to 2-Structured (based on Known Instances only)
1 | ../../patterns/1-initial/innersource-guidance-group.md
1 | ../../patterns/1-initial/innersource-customer-interview-questions.md
2 | ../../patterns/1-initial/balancing-openness-and-security.md
1 | ../../patterns/1-initial/source-code-inventory.md
1 | ../../patterns/1-initial/incubator-pipeline.md
1 | ../../patterns/1-initial/include-product-owners.md
1 | ../../patterns/1-initial/introducing-metrics-in-innersource.md
1 | ../../patterns/1-initial/modular-code.md
1 | ../../patterns/1-initial/contained-innersource.md
1 | ../../patterns/1-initial/transitioning-contractor-code-to-innersource-model.md
1 | ../../patterns/1-initial/governance-levels.md

## Structured => Validated
## 2-Structured patterns primed for upgrade to 3-Validated (based on Known Instances only)
3 | ../../patterns/2-structured/30-day-warranty.md
5 | ../../patterns/2-structured/transparent-cross-team-decision-making-using-rfcs.md
3 | ../../patterns/2-structured/document-your-guiding-principles.md
3 | ../../patterns/2-structured/trusted-committer.md
3 | ../../patterns/2-structured/core-team.md
3 | ../../patterns/2-structured/maturity-model.md
5 | ../../patterns/2-structured/innersource-portal.md
3 | ../../patterns/2-structured/gig-marketplace.md
3 | ../../patterns/2-structured/project-setup/base-documentation.md
3 | ../../patterns/2-structured/project-setup/communication-tooling.md

@spier spier added the ⚙️ Type - Meta Improving how we collaborate in this repo is the main focus of this issue / PR label Mar 21, 2023
@spier
Copy link
Member Author

spier commented May 12, 2023

As this PR is not introducing any significant changes to the content in our book, I am confident that I can merge this without review.

@yuhattor if you have a moment, I would appreciate if you could try to run the script in /meta/scripts/find_upgradeable_patterns.rb, just to confirm that it works for others too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⚙️ Type - Meta Improving how we collaborate in this repo is the main focus of this issue / PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant