Merge branch 'master' into adding-innersource-portal-examples

Author: spier

.github/workflows/main.yml

@@ -1,6 +1,7 @@
 # from: https://github.com/marketplace/actions/link-checker
+# link checker used is 'liche': https://github.com/raviqqe/liche
 
-name: Link Check on README.md
+name: Link Check on Patterns and README
 
 on: [push, pull_request]
 jobs:
@@ -12,6 +13,6 @@ jobs:
       id: lc
       uses: peter-evans/link-checker@v1
       with:
-        args: -v -d . -x "http://creativecommons.org/licenses|https://isc-inviter.herokuapp.com" README.md
+        args: -v -d . -x "http://creativecommons.org/licenses|https://isc-inviter.herokuapp.com|https://github.com/rcs/rcs-viewer/pull/81" README.md patterns/ -r
     - name: Fail if there were link errors
       run: exit ${{ steps.lc.outputs.exit_code }}

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 The goal of the InnerSource patterns working group is to collect, document, and publish InnerSource best practices. To make the best practices easy to comprehend, evaluate, and apply, we codify them in a specific structure - [the patterns format](meta/pattern-template.md). More infos on the working group can be found in our [README.md](README.md) file.
 
-For this working group to strive, we welcome your contribution - be it small or huge. 
+For this working group to strive, we welcome your contribution - be it small or huge.
 
 
 ## How to Contribute?
@@ -31,7 +31,7 @@ We are happy to support you in contributing to the InnerSource patterns or to ju
 
 ## License of Contributions
 
-The contents of this repository are licensed under [CC-BY-SA-4.0](LICENSE.md). By contributing to this repository, you grant us (and everyone else for that matter) the right to use your contribution in accordance with that license.
+The contents of this repository are licensed under [CC-BY-SA-4.0](LICENSE.txt). By contributing to this repository, you grant us (and everyone else for that matter) the right to use your contribution in accordance with that license.
 
 
 ## Code of Conduct

README.md

@@ -2,15 +2,11 @@
 
 This repository contains the InnerSource Patterns collected by the [InnerSource Commons][isc-website]. These patterns are InnerSource best practices codified in a specific format to make it easy to understand, evaluate, and reuse them.
 
-Below you find [what a pattern is][gh-what-are-patterns], a [list of known patterns][gh-list-of-patterns], and [how to use these patterns][gh-how-to-use-patterns] in your organization.
+Below you find [what a pattern is](#what-are-innersource-patterns), a [list of known patterns](#list-of-patterns), and [how to use these patterns](#how-can-you-use-innersource-patterns) in your organization.
 
-You are already using InnerSource in your company and want to share your ideas and experiences with the world? We would love to [welcome your contributions][gh-contribute]!
+You are already using InnerSource in your company and want to share your ideas and experiences with the world? We would love to [welcome your contributions](#how-to-contribute)!
 
 [isc-website]: http://innersourcecommons.org
-[gh-list-of-patterns]: https://github.com/InnerSourceCommons/InnerSourcePatterns#list-of-patterns
-[gh-what-are-patterns]: https://github.com/InnerSourceCommons/InnerSourcePatterns#what-are-inner-source-patterns
-[gh-how-to-use-patterns]: https://github.com/InnerSourceCommons/InnerSourcePatterns#how-can-you-use-inner-source-patterns
-[gh-contribute]: https://github.com/InnerSourceCommons/InnerSourcePatterns#how-to-contribute
 
 ## Mission Statement
 
@@ -35,6 +31,7 @@ The below lists all known patterns. They are grouped into three [maturity levels
 * [Contracted Contributor](patterns/2-structured/contracted-contributor.md) - *Associates wanting to contribute to InnerSource are discouraged from doing so by their line management. Relief is provided by formal contracts and agreements.*
 * [Dedicated Community Leader](patterns/2-structured/dedicated-community-leader.md) - *Select people with both communications and technical skills to lead the communities to ensure success in starting an InnerSource initiative.*
 * [Gig Marketplace](patterns/2-structured/gig-marketplace.md) - *Establish a marketplace by creating an intranet website that lists specific InnerSource project needs as "Gigs" with explicit time and skill requirements. This will enable managers to better understand their employee’s time commitment and professional benefits thereby increasing the likelihood of garnering approval to make InnerSource contributions.*
+* [Maturity Model](patterns/2-structured/maturity-model.md) - *Teams have started adopting InnerSource. The practice is spreading to multiple departments. Understanding of what constitutes an InnerSource project are wide spread though. The solution is to provide a maturity model to allow for teams to go through a self check and discover patterns and practices that they are not yet aware of.*
 * [InnerSource License](patterns/2-structured/innersource-license.md) - *Two legal entities that belong to the same organization want to share software source code with each other but they are concerned about the implications in terms of legal liabilities or cross-company accounting. An **InnerSource License** provides a reusable legal framework for the sharing of source code within the organization. This opens up new collaboration options, and makes the rights and obligations of the involved legal entities explicit.*
 * [InnerSource Portal](patterns/2-structured/innersource-portal.md) - *Create an intranet website that indexes all available InnerSource project information. This will enable potential contributors to more easily learn about projects that might interest them and for InnerSource project owners to attract an outside audience.*
 * [Praise Participants](patterns/2-structured/praise-participants.md) - *Thank contributors effectively to engender further engagement from them and to encourage others to contribute*
@@ -48,10 +45,8 @@ possible to either deploy the same service in independent environments with sepa
 
 * [Assisted Compliance](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/74) - *Helping repo owners be compliant by writing their CONTRIBUTING.md for them as a pull request.*
 * [Cross-Team Project Valuation](patterns/2-structured/crossteam-project-valuation.md) - *It's hard to sell the value of cross-team, inner sourced projects that don't provide a direct impact on company revenue. Here's a data-driven way to represent your project that both articulates its value and amplifies it.*
-* [Reluctance to Receive Contributions](https://docs.google.com/document/d/13QDN-BpE_BixRFVGjao32n4Ctim0ROXAHbBWMBOijb4/edit) - *Core owner of shared asset is reluctant to take contributions due to the required maintenance that comes with them.*
+* [Reluctance to Receive Contributions](patterns/1-initial/reluctance-to-accept-contributions.md) - *Core owner of shared asset is reluctant to take contributions due to the required maintenance that comes with them.*
 * [What Before How or Services Documentation](https://docs.google.com/document/d/1_N1wsQeDusfIcNy-O2ZXenY3PL7ZbvkUDRZxGUuegZw/edit?usp=drive_web) - *A lack of common understanding between different management tiers creates funding barriers and increases the risk that solutions will not deliver required business outcomes.*
-* [Overcome Acquisition Based Silos - Developers](patterns/2-structured/overcome-acquisition-based-silos-developer.md)
-* [Overcome Acquisition Based Silos - Managers](patterns/2-structured/overcome-acquisition-based-silos-manager.md)
 * [Open Source Trumps InnerSource](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/46) - *People find the InnerSource project but, after all things are considered, even if the InnerSource component meets their needs, they still go with the open source component.*
 * [Start as Experiment](patterns/2-structured/start-as-experiment.md) - *An inner source initiative is considered but not started, because management is unsure about its outcome and therefore unwilling to commit to the investment.*
 * [Include Product Owners](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/71) - *Key Performance Indicators (KPIs) for Product Owners are primarily product focused, and don't consider areas such as collaborative development. This results in a lower level of engagement with inner source projects.*
@@ -71,6 +66,8 @@ possible to either deploy the same service in independent environments with sepa
 
 #### Pattern Ideas (not yet proven; brainstormed)
 
+* [Overcome Acquisition Based Silos - Developers](patterns/1-initial/overcome-acquisition-based-silos-developer.md)
+* [Overcome Acquisition Based Silos - Managers](patterns/1-initial/overcome-acquisition-based-silos-manager.md)
 * [Discover Your InnerSource](patterns/1-initial/discover-your-innersource.md)
 * [Junkyard Styled Inner Sourcing](patterns/1-initial/junkyard-styled-innersourcing.md)
 * [Shared Code Repo Different from Build Repo](patterns/1-initial/shared-code-repo-different-from-build-repo.md) - *Deal with the overhead of having shared code in a separate repository that isn't the same as the project-specific one that is tied to production builds.*

meta/README.md

@@ -3,13 +3,12 @@
 The topics below cover information about how we define, operate, and upkeep this collection of patterns.
 
 * [Pattern Template](./pattern-template.md) - Start a new pattern with a copy of this
-* [Pattern States](./pattern-states.md) - Definitions of the various states and review steps a pattern can be in
-* [Pattern System](./pattern-system.md) (draft) For a human reader it is not easy to digest a long list of patterns. We are working on labeling and classifying the patterns further. See [Pattern System](pattern-system.md) for our current thoughts.
+* [Contributor Handbook](./contributor-handbook.md) - Lays out a basic guideline of how to write and contribute a new pattern, including the 3 maturity levels for patterns.
+* **(draft)** [Pattern System](./pattern-system.md) - For a human reader it is not easy to digest a long list of patterns. We are working on labeling and classifying the patterns further.
 * [Trusted Committers](../TRUSTED-COMMITTERS.md) - Who these people are, what elevated rights they get, and how you can become one
-* [Publishing](./publishing.md) - How we take completed, reviewed, proven patterns and publish them toward an online book
 * [Markdown Info](./markdown-info.md) - Markdown is the ascii text format our patterns are written in; this document briefly defines how we use it
 * [Contributing](../CONTRIBUTING.md) - How to interact with our group, create your own patterns, or take part in our review-process; Github / Web centric instructions
   * [Alternate Command-line steps](./technical-git-howto.md) - If you want to contribute a pattern using `git` from the command-line, this is your document
-  * [Meetings](./meetings.md) - Become involved with the people and communications of the Inner Source Patterns group
 * **(incomplete) Writing Guidelines** - To make the writing for our patterns more consistent, we provide some guidelines to help the various authors to keep a consistent voice.
   * [InnerSource Spelling](./innersource-spelling.md) - Clarifies the mystery around how to spell this. Spoiler: It is **InnerSource**.
+* [FAQ](./FAQ.md) - Frequently asked questions about InnerSource Patterns

meta/boardreports/2020-10-details.md

@@ -0,0 +1,52 @@
+# InnerSource Patterns WG - Report for governance meeting 2020-10
+
+**Details Section**
+ 
+## Project Activity - Describe the overall activity in the project over the past quarter.
+
+Here are some more detailed numbers as mentioned in short-form.
+
+### Pattern-work
+
+#### Entirely new & merged: 5
+
+- RFCs #204 @tsadler1988 @spier @mainec 
+- InnerSource Activity Score @michadelic SAP #189 @newmexicokid @spier
+- InnerSource License #147
+- Pattern Overview Mindmap: @feiwan2000 (very popular!) 
+- Europace sponsored: Mechanics and tooling recommendations #124, #123 #121 @mainec @rrutledge @martinklewitz @newmexicokid @sjn
+
+#### Entirely new & open: 2
+
+- #166 concept-anchor @mishari
+- #182 definition of OSS/ISS projects @chtompki
+
+#### Existing PRs/Content merged: 3
+
+- Maturity model #121 @mainec @dizquierdo
+- Draft from Galway "Who is using my code" #112 @StingrayZA
+- Reluctance to accept contributions #199 from GDoc via @spier from Klaas & others (see pattern)
+
+#### Progress on existing PRs: 8
+
+- #95 (almost done, @gruetter), #46 (#216, @gruetter) #120 #84 #78 #74 #71 #64 
+
+### Technical contributions: about 8
+
+- Content linting #168, #222, @spier, @nschonni
+- rendering to Gitbook @217 @spier
+- linkchecking #157 @spier #146 #145
+
+### Cleanup, Fixing & Migration: a lot
+
+- Fixing countless typos, broken links and inconsistent templates/documentation: @spier 
+- Spelling, typos, examples #176, #175 @jpatrao
+- Typos, small improvements @stingrayza, @michadelic @funzinator
+
+### General statistics
+
+- PRs closed: 23
+- PRs created: 19
+- Open PRs (end of quarter): 20
+- Open Issues (end of quarter): 27
+- trusted committers: 5 (active ~3)

meta/boardreports/2020-10.md

@@ -0,0 +1,68 @@
+# InnerSource Patterns WG - Report for governance meeting 2020-10
+
+**Data from June to September**
+
+## Mission - Briefly describe what your project actually does.
+
+- Discuss community InnerSource practices and dynamics, collect and document agreed upon best practices of how to do InnerSource - in the form of patterns
+- Continuously publish the most mature patterns as an ebook and website
+
+## Project/Community Status and Health - Sum up the status and health of your project and community in a few sentences
+
+- This project is seeing more activity than ~1 year ago, with 10 new contributors, some of them repeatedly, some major contributions, lots of evolutionary improvements. Also new contributions from past contributors.
+- Activity and trusted committer diversity is still too low to sustain the project in the long run on a high activity level. Low activity evolution is sustainable.
+
+## Project Activity - Describe the overall activity in the project over the past quarter.
+
+- New process proposal by @maxcapraro, discussion (@spier @mainec @newmexicokid @lenucksi) and successful adoption (initial, structured, validated, goal: faster first contribution, see contributor handbook)
+- Processing of existing content from wiki and existing PRs into publishable repo content, large scale cleanup, migration and fixing, all ongoing for the foreseeable future. 
+- Great work towards content rendering (e.g. website, initial PDFs) in progress @spier @dizquerdo (https://innersourcecommons.gitbook.io/innersource-patterns-staging/v/book/)
+- Conference activity, more, interesting pattern activity on Slack leading to new patterns 
+- Patterns office-hours concept try out, some success, dual time-zone meeting concept successfully in use in marketing wg
+
+### Pattern-work
+
+- This is condensed overview. See [details](2020-10-details.md) for details with contributors.
+- Entirely new & merged: 5
+- Entirely new & open: 2
+- Existing PRs/Content merged: 3
+- Progress on existing PRs: 8
+- Technical contributions: ca. 8
+- Cleanup, Fixing & Migration: a lot
+- Trusted committers: 5 (active ~3)
+
+## Plans of the Project
+
+**Describe the current plans of the project. Include goals the project is working towards as well as any announcements that should be published through the marketing group.**
+
+- Publish our first official ebook of the InnerSource patterns. Once we do that, let’s announce that through our Marketing WG.
+- Process existing content from pull requests and Google group into our repository
+- Evaluate ideas to further facilitate collection of pattern content (e.g. through automation), channel ongoing discussions into pattern-work and attract more contributors, e.g. by lowering the barriers of entry for them.
+- Onboard further trusted committers
+- Possibly review the current list of trusted committers. Some of them don’t seem to be active anymore (likely they receive a lot of github/email spam from us today).
+
+## Last Committer Addition
+
+**When was the last committer added to the project? A healthy project tends to add new committers regularly. The report should indicate the most recent date on which a committer was added.**
+
+- 24th of April 2020: @lenucksi
+
+## Committer Diversity
+
+**Cover committer diversity in your project. A healthy project should survive the departure of any single contributor or employer of contributors. What are your steps to make sure that people from all regions on the globe can participate in your project without having to be awake at midnight their local time?**
+
+- Focus on asynchronous collab in the #innersource-patterns channel
+- Offering of office hours on APAC and EU/Americas friendly timeslots
+- Work towards automation of administration tasks, documentation of processes
+- Have TCs in multiple time zones
+
+## Legal Issues & Other Needs
+
+**Are there any project branding or naming issues, either in the project or externally? Any legal issues? Any infrastructure or strategic needs?**
+
+- None currently, book illustrations will trigger IP compliance requirements.
+- Suggestions welcome on how to attract more contributors.
+
+## Any issues for the Board to act on?
+
+- None