From 985bc7e3aaec2e3df57dd762ee8fa6fdea4518be Mon Sep 17 00:00:00 2001 From: Isabel Drost-Fromm Date: Wed, 26 Jun 2024 11:44:17 +0200 Subject: [PATCH 01/20] Create governance-based-project-setup.md As discussed in Slack previously this adds a new pattern to link our Governance Levels with information on what pre-requisits need to be fulfilled to reach the respective governance level. The pattern looks at several factors: * Knowledge needed by contributors and host team. * General advise on project structure. * Maturity levels that need to be reached. * Relevant patterns. --- .../governance-based-project-setup.md | 87 +++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 patterns/1-initial/governance-based-project-setup.md diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md new file mode 100644 index 000000000..65c1113a2 --- /dev/null +++ b/patterns/1-initial/governance-based-project-setup.md @@ -0,0 +1,87 @@ +## Title + +Governance Level Guided Project Setup + +## Patlet + +A team wants to setup a new InnerSource project or convert an existing project to be InnerSource ready. They already decided on a [Governance Level](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/governance-levels.md) to use. However the team is at a loss at what the chosen Governance Level means in terms of impact on the project. + +Following our list of best practices, recommended patterns and maturity levels to reach helps address this problem. + +## Problem + +A team has decided that they want to publish an InnerSource project. They are trying to decide on a governance level. However lacking practical experience they need further guidance on the impact each of the levels will have on their daily doing. + +## Context + +- The team has expierence working as contributors to other InnerSource projects. +- The team would like to publish an InnerSource project themselves but has only limited InnerSource Trusted Committer experience. +- The team does have enough autonomy to decide on how much time they can invest into supporting the resulting InnerSource project. + +## Forces + +- Contributors need clarity on what to expect from an InnerSource project in terms of transparency and collaboration opportunities. +- New Trusted Committers need an understanding of the level of work the future governance level entails. +- New Trusted Committers may need to communicate expected impact for capacity planning. + +## Solution + +Support new Trusted committers with a list of resources targeted at each of the three governance levels. + +### Level: "Bug reports and Issues welcome" + +Ideally the host team goes through the InnerSource Learning Path to get a first understanding of the concepts and roles involved. + +To reach this level, a team needs to make their source code readable. They need to give write access to their issue tracker. + +For the maturity model, the relevant levels needed are at least: + +PP-1, DP-1, DC-1, RS-1, ST-1, CF-1, LS-1, OF-2, CB-2, SP-2, PA-2, RW-1, MP-1, SM-1, CL-1, RO-1 + +For InnerSource patterns, start by looking at the following ones: + +* [Base Documentation](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/base-documentation.md) +* [Communiation Tooling](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/communication-tooling.md) +* [Issue Tracker](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/issue-tracker.md) +* [Praise Participants](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/praise-participants.md) +* [Standard Release Process](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/release-process.md) +* [Trusted Committer](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/trusted-committer.md) +* [Improve Findability](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/improve-findability.md) + + +### Level: "Contributions Welcome" + +To reach this level, a team needs to give contributors the option to submit pull requests. In addition, contributors need to have clear options to follow the development of the project in order to better understand project direction and established best practices. In addition the host team needs to set aside time for mentoring contributors and giving timely feedback. + +For the maturity model, the relevant levels needed are at least: + +PP-2, DP-2, DC-2, RS-3, ST-3, CF-2, LS-2, OF-2, CB-2, SP-2, PA-2, RW-2, MP-2, SM-2, CL-3, RO-2 + +For InnerSource patterns, start by looking at the following ones (in addition to the ones above): + +* [30-day warranty](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/30-day-warranty.md) +* [Extensions for Sustainable Growth](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/extensions-for-sustainable-growth.md) +* [Review Committee](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/review-committee.md) +* [Service vs. Library](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/service-vs-library.md) +* [Transparent cross team decision making](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/transparent-cross-team-decision-making-using-rfcs.md) +* [Cross team retrospectives](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/cross-team-retrospectives.md) +* [Incentive Mechanisms](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/incentive-mechanisms-for-voluntary-contribution.md) +* [Include Product Owners](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/include-product-owners.md) +* [Reluctance to accept contributions](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/reluctance-to-accept-contributions.md) + +### Level: Shared Ownership + +To reach this level the host team mixed of members of different teams in the organisation needs to understand that they are to act as one virtual team. There needs to be alignment of where the project is headed and increased trust between Trusted Committers. + +All project decisions need to be taken where they can not only be seen by others but influenced by the entire team of Trusted Committers - even if not all can make it to all meetings. + +For the maturity model, the relevant levels needed are at least: + +PP-3, DP-3, DC-3, RS-3, ST-3, CF-3, LS-3, OF-3, CB-3, SP-3, PS-3, RW-3, MP-3, SM-3, CL-3, RO-3 + +For InnerSource patterns, start by looking at the following ones (in addition to the ones above): + +* [Group Support](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/group-support.md) +* [Explicit Shared Ownership](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/explicit-shared-ownership.md) +* [Modular Code](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/modular-code.md) +* [Source Repo different from deployment chain](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/shared-code-repo-different-from-build-repo.md) From 8615d5d231b1545461a155eb009ad014f52bbad7 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Wed, 26 Jun 2024 20:48:44 +0200 Subject: [PATCH 02/20] Make links relative --- .../1-initial/governance-based-project-setup.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md index 65c1113a2..9d2712113 100644 --- a/patterns/1-initial/governance-based-project-setup.md +++ b/patterns/1-initial/governance-based-project-setup.md @@ -40,13 +40,13 @@ PP-1, DP-1, DC-1, RS-1, ST-1, CF-1, LS-1, OF-2, CB-2, SP-2, PA-2, RW-1, MP-1, SM For InnerSource patterns, start by looking at the following ones: -* [Base Documentation](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/base-documentation.md) -* [Communiation Tooling](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/communication-tooling.md) -* [Issue Tracker](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/issue-tracker.md) -* [Praise Participants](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/praise-participants.md) -* [Standard Release Process](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/release-process.md) -* [Trusted Committer](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/trusted-committer.md) -* [Improve Findability](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/improve-findability.md) +* [Base Documentation](../2-structured/base-documentation.md) +* [Communiation Tooling](../2-structured/communication-tooling.md) +* [Issue Tracker](../2-structured/issue-tracker.md) +* [Praise Participants](../2-structured/praise-participants.md) +* [Standard Release Process](../2-structured/release-process.md) +* [Trusted Committer](../2-structured/trusted-committer.md) +* [Improve Findability](../1-initial/improve-findability.md) ### Level: "Contributions Welcome" From a53a78e047895ed5a864b68a1a18ef4a0c8344b8 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Wed, 26 Jun 2024 20:49:01 +0200 Subject: [PATCH 03/20] Make links relative --- .../governance-based-project-setup.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md index 9d2712113..56716c30b 100644 --- a/patterns/1-initial/governance-based-project-setup.md +++ b/patterns/1-initial/governance-based-project-setup.md @@ -59,15 +59,15 @@ PP-2, DP-2, DC-2, RS-3, ST-3, CF-2, LS-2, OF-2, CB-2, SP-2, PA-2, RW-2, MP-2, SM For InnerSource patterns, start by looking at the following ones (in addition to the ones above): -* [30-day warranty](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/30-day-warranty.md) -* [Extensions for Sustainable Growth](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/extensions-for-sustainable-growth.md) -* [Review Committee](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/review-committee.md) -* [Service vs. Library](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/service-vs-library.md) -* [Transparent cross team decision making](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/transparent-cross-team-decision-making-using-rfcs.md) -* [Cross team retrospectives](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/cross-team-retrospectives.md) -* [Incentive Mechanisms](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/incentive-mechanisms-for-voluntary-contribution.md) -* [Include Product Owners](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/include-product-owners.md) -* [Reluctance to accept contributions](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/reluctance-to-accept-contributions.md) +* [30-day warranty](../2-structured/30-day-warranty.md) +* [Extensions for Sustainable Growth](../2-structured/extensions-for-sustainable-growth.md) +* [Review Committee](../2-structured/review-committee.md) +* [Service vs. Library](../2-structured/service-vs-library.md) +* [Transparent cross team decision making](../2-structured/transparent-cross-team-decision-making-using-rfcs.md) +* [Cross team retrospectives](../1-initial/cross-team-retrospectives.md) +* [Incentive Mechanisms](../1-initial/incentive-mechanisms-for-voluntary-contribution.md) +* [Include Product Owners](../1-initial/include-product-owners.md) +* [Reluctance to accept contributions](../1-initial/reluctance-to-accept-contributions.md) ### Level: Shared Ownership From 6666157336cde5e66be76d83e22d1b428305f5a7 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Wed, 26 Jun 2024 20:49:09 +0200 Subject: [PATCH 04/20] Make links relative --- patterns/1-initial/governance-based-project-setup.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md index 56716c30b..2fc7c2607 100644 --- a/patterns/1-initial/governance-based-project-setup.md +++ b/patterns/1-initial/governance-based-project-setup.md @@ -81,7 +81,7 @@ PP-3, DP-3, DC-3, RS-3, ST-3, CF-3, LS-3, OF-3, CB-3, SP-3, PS-3, RW-3, MP-3, SM For InnerSource patterns, start by looking at the following ones (in addition to the ones above): -* [Group Support](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/2-structured/group-support.md) -* [Explicit Shared Ownership](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/explicit-shared-ownership.md) -* [Modular Code](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/modular-code.md) -* [Source Repo different from deployment chain](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/shared-code-repo-different-from-build-repo.md) +* [Group Support](../2-structured/group-support.md) +* [Explicit Shared Ownership](../1-initial/explicit-shared-ownership.md) +* [Modular Code](../1-initial/modular-code.md) +* [Source Repo different from deployment chain](../1-initial/shared-code-repo-different-from-build-repo.md) From 5df151fef055a799eb7b6975789fb1ff29bf4052 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Wed, 26 Jun 2024 20:49:24 +0200 Subject: [PATCH 05/20] Markdownlint fixes --- patterns/1-initial/governance-based-project-setup.md | 1 - 1 file changed, 1 deletion(-) diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md index 2fc7c2607..a772fcd60 100644 --- a/patterns/1-initial/governance-based-project-setup.md +++ b/patterns/1-initial/governance-based-project-setup.md @@ -48,7 +48,6 @@ For InnerSource patterns, start by looking at the following ones: * [Trusted Committer](../2-structured/trusted-committer.md) * [Improve Findability](../1-initial/improve-findability.md) - ### Level: "Contributions Welcome" To reach this level, a team needs to give contributors the option to submit pull requests. In addition, contributors need to have clear options to follow the development of the project in order to better understand project direction and established best practices. In addition the host team needs to set aside time for mentoring contributors and giving timely feedback. From 408c35bfc3906319d97b58f9a77ae54d7ba0a528 Mon Sep 17 00:00:00 2001 From: Isabel Drost-Fromm Date: Fri, 28 Jun 2024 10:07:24 +0200 Subject: [PATCH 06/20] Update patterns/1-initial/governance-based-project-setup.md Co-authored-by: Sebastian Spier --- patterns/1-initial/governance-based-project-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md index a772fcd60..40abaab15 100644 --- a/patterns/1-initial/governance-based-project-setup.md +++ b/patterns/1-initial/governance-based-project-setup.md @@ -4,7 +4,7 @@ Governance Level Guided Project Setup ## Patlet -A team wants to setup a new InnerSource project or convert an existing project to be InnerSource ready. They already decided on a [Governance Level](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/patterns/1-initial/governance-levels.md) to use. However the team is at a loss at what the chosen Governance Level means in terms of impact on the project. +A team wants to a project to be InnerSource ready. They already decided on a [Governance Level](../1-initial/governance-levels.md) to use. However the team is at a loss at what the chosen Governance Level means in terms of impact on the project. Following our list of best practices, recommended patterns and maturity levels to reach helps address this problem. From 295be6b71d52a59e881e23b3a5518d838a4c9bc1 Mon Sep 17 00:00:00 2001 From: Isabel Drost-Fromm Date: Fri, 28 Jun 2024 10:09:29 +0200 Subject: [PATCH 07/20] Update governance-based-project-setup.md --- patterns/1-initial/governance-based-project-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md index 40abaab15..f99c449b2 100644 --- a/patterns/1-initial/governance-based-project-setup.md +++ b/patterns/1-initial/governance-based-project-setup.md @@ -4,7 +4,7 @@ Governance Level Guided Project Setup ## Patlet -A team wants to a project to be InnerSource ready. They already decided on a [Governance Level](../1-initial/governance-levels.md) to use. However the team is at a loss at what the chosen Governance Level means in terms of impact on the project. +A team wants a project to be InnerSource ready. They want to choose a [Governance Level](../1-initial/governance-levels.md) but need more information on how each level impacts processes. Following our list of best practices, recommended patterns and maturity levels to reach helps address this problem. From 7b0fbb81b952e40d1de2c102aa1734ff3131d8e0 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Wed, 3 Jul 2024 23:35:08 +0200 Subject: [PATCH 08/20] Spelling fix --- patterns/1-initial/governance-based-project-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md index f99c449b2..0c60d6a5e 100644 --- a/patterns/1-initial/governance-based-project-setup.md +++ b/patterns/1-initial/governance-based-project-setup.md @@ -14,7 +14,7 @@ A team has decided that they want to publish an InnerSource project. They are tr ## Context -- The team has expierence working as contributors to other InnerSource projects. +- The team has experience working as contributors to other InnerSource projects. - The team would like to publish an InnerSource project themselves but has only limited InnerSource Trusted Committer experience. - The team does have enough autonomy to decide on how much time they can invest into supporting the resulting InnerSource project. From 33c20e637cee6a224cc1fcb5e628a7af6ba43e18 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Tue, 31 Dec 2024 09:32:05 +0100 Subject: [PATCH 09/20] Add links to Maturity Model pattern --- patterns/1-initial/governance-based-project-setup.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md index 0c60d6a5e..c9d75a99c 100644 --- a/patterns/1-initial/governance-based-project-setup.md +++ b/patterns/1-initial/governance-based-project-setup.md @@ -34,7 +34,7 @@ Ideally the host team goes through the InnerSource Learning Path to get a first To reach this level, a team needs to make their source code readable. They need to give write access to their issue tracker. -For the maturity model, the relevant levels needed are at least: +For the [maturity model](../2-structured/maturity-model.md), the relevant levels needed are at least: PP-1, DP-1, DC-1, RS-1, ST-1, CF-1, LS-1, OF-2, CB-2, SP-2, PA-2, RW-1, MP-1, SM-1, CL-1, RO-1 @@ -52,7 +52,7 @@ For InnerSource patterns, start by looking at the following ones: To reach this level, a team needs to give contributors the option to submit pull requests. In addition, contributors need to have clear options to follow the development of the project in order to better understand project direction and established best practices. In addition the host team needs to set aside time for mentoring contributors and giving timely feedback. -For the maturity model, the relevant levels needed are at least: +For the [maturity model](../2-structured/maturity-model.md), the relevant levels needed are at least: PP-2, DP-2, DC-2, RS-3, ST-3, CF-2, LS-2, OF-2, CB-2, SP-2, PA-2, RW-2, MP-2, SM-2, CL-3, RO-2 @@ -74,7 +74,7 @@ To reach this level the host team mixed of members of different teams in the org All project decisions need to be taken where they can not only be seen by others but influenced by the entire team of Trusted Committers - even if not all can make it to all meetings. -For the maturity model, the relevant levels needed are at least: +For the [maturity model](../2-structured/maturity-model.md), the relevant levels needed are at least: PP-3, DP-3, DC-3, RS-3, ST-3, CF-3, LS-3, OF-3, CB-3, SP-3, PS-3, RW-3, MP-3, SM-3, CL-3, RO-3 From 452a2379affddf954459eeefb4e5d2f61e5d8c97 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Tue, 31 Dec 2024 09:39:08 +0100 Subject: [PATCH 10/20] Minor rewording --- patterns/1-initial/governance-based-project-setup.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md index c9d75a99c..3125b67ae 100644 --- a/patterns/1-initial/governance-based-project-setup.md +++ b/patterns/1-initial/governance-based-project-setup.md @@ -70,9 +70,9 @@ For InnerSource patterns, start by looking at the following ones (in addition to ### Level: Shared Ownership -To reach this level the host team mixed of members of different teams in the organisation needs to understand that they are to act as one virtual team. There needs to be alignment of where the project is headed and increased trust between Trusted Committers. +To reach this level the host team, mixed of members of different teams in the organisation, needs to understand that they are to act as one virtual team. There needs to be alignment of where the project is headed and increased trust between Trusted Committers. -All project decisions need to be taken where they can not only be seen by others but influenced by the entire team of Trusted Committers - even if not all can make it to all meetings. +All project decisions need to be taken where they can not only be seen by others but influenced by the entire team of Trusted Committers - even if not everybody can make it to all meetings. For the [maturity model](../2-structured/maturity-model.md), the relevant levels needed are at least: From b7a95de9bb8c60568974faccb4bafc32e4ebe829 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Tue, 31 Dec 2024 09:39:47 +0100 Subject: [PATCH 11/20] Moving link to Governance level pattern from Patlet to Problem section --- patterns/1-initial/governance-based-project-setup.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md index 3125b67ae..ba6f54444 100644 --- a/patterns/1-initial/governance-based-project-setup.md +++ b/patterns/1-initial/governance-based-project-setup.md @@ -4,13 +4,13 @@ Governance Level Guided Project Setup ## Patlet -A team wants a project to be InnerSource ready. They want to choose a [Governance Level](../1-initial/governance-levels.md) but need more information on how each level impacts processes. +A team wants a project to be InnerSource ready. They want to choose a Governance Level but need more information on how each level impacts processes. Following our list of best practices, recommended patterns and maturity levels to reach helps address this problem. ## Problem -A team has decided that they want to publish an InnerSource project. They are trying to decide on a governance level. However lacking practical experience they need further guidance on the impact each of the levels will have on their daily doing. +A team has decided that they want to publish an InnerSource project. They are trying to decide on a [Governance Level](../1-initial/governance-levels.md). However lacking practical experience they need further guidance on the impact each of the levels will have on their daily doing. ## Context From 15485698e37d15174688cdb5184eee9bf709cc9e Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Tue, 31 Dec 2024 09:42:06 +0100 Subject: [PATCH 12/20] Rewording --- patterns/1-initial/governance-based-project-setup.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md index ba6f54444..877d51210 100644 --- a/patterns/1-initial/governance-based-project-setup.md +++ b/patterns/1-initial/governance-based-project-setup.md @@ -10,7 +10,7 @@ Following our list of best practices, recommended patterns and maturity levels t ## Problem -A team has decided that they want to publish an InnerSource project. They are trying to decide on a [Governance Level](../1-initial/governance-levels.md). However lacking practical experience they need further guidance on the impact each of the levels will have on their daily doing. +A team has decided that they want to publish an InnerSource project. They are trying to decide on a [Governance Level](../1-initial/governance-levels.md) for their project. However lacking practical experience they need further guidance on the impact each of the levels will have on their daily doing. ## Context @@ -26,7 +26,7 @@ A team has decided that they want to publish an InnerSource project. They are tr ## Solution -Support new Trusted committers with a list of resources targeted at each of the three governance levels. +Support new Trusted Committers with a list of resources targeted at each of the three governance levels. ### Level: "Bug reports and Issues welcome" From fb5d6ac869a0ab5ffa5e61201456332df94a44f0 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Tue, 31 Dec 2024 09:42:52 +0100 Subject: [PATCH 13/20] Link to Learning Path --- patterns/1-initial/governance-based-project-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md index 877d51210..ab23066a7 100644 --- a/patterns/1-initial/governance-based-project-setup.md +++ b/patterns/1-initial/governance-based-project-setup.md @@ -30,7 +30,7 @@ Support new Trusted Committers with a list of resources targeted at each of the ### Level: "Bug reports and Issues welcome" -Ideally the host team goes through the InnerSource Learning Path to get a first understanding of the concepts and roles involved. +Ideally the host team goes through the [InnerSource Learning Path](https://innersourcecommons.org/learn/learning-path/) to get a first understanding of the concepts and roles involved. To reach this level, a team needs to make their source code readable. They need to give write access to their issue tracker. From dc838fd41ed42d6e3104473be231f933d6471fdb Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Tue, 31 Dec 2024 09:49:17 +0100 Subject: [PATCH 14/20] Include the model definitions from the Governance Levels in here to make the link to the other pattern even more explicit (even though this means repetition) --- .../1-initial/governance-based-project-setup.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md index ab23066a7..da2334d6a 100644 --- a/patterns/1-initial/governance-based-project-setup.md +++ b/patterns/1-initial/governance-based-project-setup.md @@ -28,7 +28,10 @@ A team has decided that they want to publish an InnerSource project. They are tr Support new Trusted Committers with a list of resources targeted at each of the three governance levels. -### Level: "Bug reports and Issues welcome" +### Governance Level: "Bug reports and Issues welcome" + +Definition: +> People outside the core development team may use the code. They can submit feature requests and bug reports for things they would like to see changed. Ideally the host team goes through the [InnerSource Learning Path](https://innersourcecommons.org/learn/learning-path/) to get a first understanding of the concepts and roles involved. @@ -48,7 +51,10 @@ For InnerSource patterns, start by looking at the following ones: * [Trusted Committer](../2-structured/trusted-committer.md) * [Improve Findability](../1-initial/improve-findability.md) -### Level: "Contributions Welcome" +### Governance Level: "Contributions Welcome" + +Definition: +> People outside the core development team may use the code. They can also make modifications and submit them to core team for inclusion. To reach this level, a team needs to give contributors the option to submit pull requests. In addition, contributors need to have clear options to follow the development of the project in order to better understand project direction and established best practices. In addition the host team needs to set aside time for mentoring contributors and giving timely feedback. @@ -68,7 +74,10 @@ For InnerSource patterns, start by looking at the following ones (in addition to * [Include Product Owners](../1-initial/include-product-owners.md) * [Reluctance to accept contributions](../1-initial/reluctance-to-accept-contributions.md) -### Level: Shared Ownership +### Governance Level: Shared Ownership + +Definition: +> Members of different teams collaborate on the project as equal peers. Everyone has the ability to merge code. Everyone has an equal say on the project direction. Everyone has an equal say in who else to add to this group. To reach this level the host team, mixed of members of different teams in the organisation, needs to understand that they are to act as one virtual team. There needs to be alignment of where the project is headed and increased trust between Trusted Committers. From c3501cac3924caa4694a4b12500b0bb30e74532d Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Tue, 31 Dec 2024 10:27:39 +0100 Subject: [PATCH 15/20] Adding some elements to explain the structure of the Solution section in more detail --- .../governance-based-project-setup.md | 22 ++++++++++++------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md index da2334d6a..b49883cec 100644 --- a/patterns/1-initial/governance-based-project-setup.md +++ b/patterns/1-initial/governance-based-project-setup.md @@ -28,23 +28,29 @@ A team has decided that they want to publish an InnerSource project. They are tr Support new Trusted Committers with a list of resources targeted at each of the three governance levels. -### Governance Level: "Bug reports and Issues welcome" +This solution ties together various resources that are provided by the InnerSource Commons: +- the [maturity model](../2-structured/maturity-model.md) +- InnerSource Patterns applicable to each level + +Your organization may have other custom resources relevant for each of these governance levels, that you could link to in addition to the above. + +### Governance Level: "Bug Reports and Issues Welcome" Definition: > People outside the core development team may use the code. They can submit feature requests and bug reports for things they would like to see changed. -Ideally the host team goes through the [InnerSource Learning Path](https://innersourcecommons.org/learn/learning-path/) to get a first understanding of the concepts and roles involved. - To reach this level, a team needs to make their source code readable. They need to give write access to their issue tracker. -For the [maturity model](../2-structured/maturity-model.md), the relevant levels needed are at least: +Ideally the host team goes through the [InnerSource Learning Path](https://innersourcecommons.org/learn/learning-path/) to get a first understanding of the concepts and roles involved. + +The relevant levels of the [maturity model](../2-structured/maturity-model.md) are at least: PP-1, DP-1, DC-1, RS-1, ST-1, CF-1, LS-1, OF-2, CB-2, SP-2, PA-2, RW-1, MP-1, SM-1, CL-1, RO-1 -For InnerSource patterns, start by looking at the following ones: +These InnerSource patterns, start by looking at the following ones: * [Base Documentation](../2-structured/base-documentation.md) -* [Communiation Tooling](../2-structured/communication-tooling.md) +* [Communication Tooling](../2-structured/communication-tooling.md) * [Issue Tracker](../2-structured/issue-tracker.md) * [Praise Participants](../2-structured/praise-participants.md) * [Standard Release Process](../2-structured/release-process.md) @@ -58,7 +64,7 @@ Definition: To reach this level, a team needs to give contributors the option to submit pull requests. In addition, contributors need to have clear options to follow the development of the project in order to better understand project direction and established best practices. In addition the host team needs to set aside time for mentoring contributors and giving timely feedback. -For the [maturity model](../2-structured/maturity-model.md), the relevant levels needed are at least: +The relevant levels of the [maturity model](../2-structured/maturity-model.md) are at least: PP-2, DP-2, DC-2, RS-3, ST-3, CF-2, LS-2, OF-2, CB-2, SP-2, PA-2, RW-2, MP-2, SM-2, CL-3, RO-2 @@ -83,7 +89,7 @@ To reach this level the host team, mixed of members of different teams in the or All project decisions need to be taken where they can not only be seen by others but influenced by the entire team of Trusted Committers - even if not everybody can make it to all meetings. -For the [maturity model](../2-structured/maturity-model.md), the relevant levels needed are at least: +The relevant levels of the [maturity model](../2-structured/maturity-model.md) are at least: PP-3, DP-3, DC-3, RS-3, ST-3, CF-3, LS-3, OF-3, CB-3, SP-3, PS-3, RW-3, MP-3, SM-3, CL-3, RO-3 From ae7e10f2d7724335e019463f14731db263810fd5 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Tue, 31 Dec 2024 10:32:13 +0100 Subject: [PATCH 16/20] Adding other sections in preparation for moving the pattern to maturity 'Structured' in the future --- .../1-initial/governance-based-project-setup.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md index b49883cec..acd45cd5b 100644 --- a/patterns/1-initial/governance-based-project-setup.md +++ b/patterns/1-initial/governance-based-project-setup.md @@ -99,3 +99,19 @@ For InnerSource patterns, start by looking at the following ones (in addition to * [Explicit Shared Ownership](../1-initial/explicit-shared-ownership.md) * [Modular Code](../1-initial/modular-code.md) * [Source Repo different from deployment chain](../1-initial/shared-code-repo-different-from-build-repo.md) + +## Resulting Context + +TBD + +## Known Instances + +TBD + +## Status + +- Intiial + +## Authors + +- Isabel Drost-Fromm From 011ee5d5c6a13a736c682d79e142af764021b525 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Tue, 31 Dec 2024 10:37:20 +0100 Subject: [PATCH 17/20] Formatting fixes --- patterns/1-initial/governance-based-project-setup.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md index acd45cd5b..69f499cf2 100644 --- a/patterns/1-initial/governance-based-project-setup.md +++ b/patterns/1-initial/governance-based-project-setup.md @@ -29,10 +29,12 @@ A team has decided that they want to publish an InnerSource project. They are tr Support new Trusted Committers with a list of resources targeted at each of the three governance levels. This solution ties together various resources that are provided by the InnerSource Commons: -- the [maturity model](../2-structured/maturity-model.md) -- InnerSource Patterns applicable to each level -Your organization may have other custom resources relevant for each of these governance levels, that you could link to in addition to the above. +- the [Maturity Model](../2-structured/maturity-model.md) +- **InnerSource Patterns** applicable to each level + +Your organization may have additional custom resources relevant for each of these governance levels. +You may want to link to those in addition to the ones above. ### Governance Level: "Bug Reports and Issues Welcome" From 49518668f9468881d9fd0a553799fc7332bf4885 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Tue, 31 Dec 2024 10:50:01 +0100 Subject: [PATCH 18/20] Rewriting the Patlet --- patterns/1-initial/governance-based-project-setup.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/patterns/1-initial/governance-based-project-setup.md b/patterns/1-initial/governance-based-project-setup.md index 69f499cf2..4ccf7adce 100644 --- a/patterns/1-initial/governance-based-project-setup.md +++ b/patterns/1-initial/governance-based-project-setup.md @@ -4,13 +4,12 @@ Governance Level Guided Project Setup ## Patlet -A team wants a project to be InnerSource ready. They want to choose a Governance Level but need more information on how each level impacts processes. - -Following our list of best practices, recommended patterns and maturity levels to reach helps address this problem. +Before publishing their first InnerSource project, a team wants to choose an appropriate Governance Level but is unsure about the impact of the different levels on their daily doing. +A dedicated list of resources (best practices, recommended patterns, target maturity levels) provides specific guidance to the team and helps them to make an educated decision. ## Problem -A team has decided that they want to publish an InnerSource project. They are trying to decide on a [Governance Level](../1-initial/governance-levels.md) for their project. However lacking practical experience they need further guidance on the impact each of the levels will have on their daily doing. +A team has decided that they want to publish an InnerSource project. They are trying to decide on a [Governance Level](../1-initial/governance-levels.md) for their project. However lacking practical experience, they need further guidance on the impact each of the levels will have on their daily doing. ## Context From e992138e74289cca12564f5285f1be8dfea92e47 Mon Sep 17 00:00:00 2001 From: Sebastian Spier Date: Tue, 31 Dec 2024 11:02:34 +0100 Subject: [PATCH 19/20] Adding pattern to the overview of all patterns --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 6db5880c6..49d3edf8a 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,7 @@ Our mission * [Creating an InnerSource Strategy](/patterns/1-initial/creating_an_innersource_strategy.md) - *Sometimes, it is difficult to convince people of the relevance of InnerSource for your organization and/or to get support from management. Creating an InnerSource strategy, that connects your InnerSource approach and activities to the goals and the overall strategy of your organization, can help in this regard.* * [Code of Conduct](/patterns/1-initial/code-of-conduct.md) - *Communications and interactions between collaborators are rude, not inclusive or offensive, harming and increasing the discussions without any value added. A Code of Conduct provides guidelines for establishing rules and expectations regarding behavior and interactions within the community to build stronger levels of collaboration.* * [Trusted Committer and Contributor Retrospectives](/patterns/1-initial/cross-team-retrospectives.md) - *A host team working with contributors outside of their own line of management constantly runs into misunderstandings. As a result collaboration becomes brittle and frustrating. Setting aside time for regular retrospectives for the InnerSource team consisting of trusted committers and contributors can help make communication smooth.* +* [Governance Level Guided Project Setup](/patterns/1-initial/governance-based-project-setup.md) - *Before publishing their first InnerSource project, a team wants to choose an appropriate Governance Level but is unsure about the impact of the different levels on their daily doing. A dedicated list of resources (best practices, recommended patterns, target maturity levels) provides specific guidance to the team and helps them to make an educated decision.*