This repository serves as the collection-point, ideation hub, and process behind the InnerSource Commons' set of proven and reviewed InnerSource approaches (patterns). These patterns illustrate beneficial activities and behaviors found in organizations who apply InnerSource methodologies.
Patterns are a way of describing a repeatable, proven solution to a problem with a context. They follow a simple form that helps people wanting to implement the solution to understand the constraints on the problem, the forces that must be balanced and the resulting context (the situation you are left with after the solution is applied). In inner sourcing, patterns can provide a way for the InnerSource Commons participants to concisely share information with each other, improving the practice of inner sourcing. Each of the patterns are divided into Title, Problem Statement, Context, Forces, and Solutions as their main sections.
What are patterns?
Youtube videos - Watch a set of 2-5 min youtube videos explaining Inner Source Patterns- Pattern Discussion Webinar - We held a webinar to live-discuss a pattern (go to 24:30 for the discussion)
- Detailed Pattern Background and Examples (PDF) - Get a detailed understanding of why and how to interact with our patterns during this presentation from Tim Yao and Padma Sudarsan from the ISC Fall Summit in 2016
- Pattern Template File - View a skeleton inner source pattern to get an idea on what goes into a new pattern!
Patterns must be used in a thoughtful manner. They cannot be blindly applied. In most cases, you will need to adapt the given solution to your own situation; but the information given in the pattern, defining the context (immovable constraints) and forces (constraints that can be changed and balanced against each other), should help you do this.
The pattern form is useful for describing proven patterns but it could also be used for brainstorming solutions where patterns are not yet established, since the form gives a structured way for thinking about a problem. You could also create a donut pattern (filling in the problem, context, forces and resulting context fields but leaving the solution blank) as a way of asking the InnerSource Commons community for help (to find a proven solution or to brainstorm things to try).
See our CONTRIBUTING.md for details on getting involved
We encourage beginners seeking answers to jump in by creating ''donuts'' (problems without solutions). We encourage experts to pad their experience - these are hoped to become part of a book one day. Anyone can offer reviews and comments for in-progress patterns.
We work together via Github, Webex, Slack, etc. Do not hesitate to join the #innersourcecommons or #innersource-patterns slack channels and ask to be included in the patterns meetings (there is an email list).
The below lists all known patterns. They are grouped into four stages of maturity.
- Common Requirements
- Reluctance to Receive Contributions
- Contained Inner Source
- Review Committee
- What Before How or Services Documentation
- Overcome Acquisition Based Silos - Developers
- Overcome Acquisition Based Silos - Managers
- Open Source Trumps InnerSource
- Overcoming Project Management Time Pressures
- Poor Naming Conventions
- Don't Bother Looking
- Junkyard Styled Inner Sourcing
- Different Repo For Shared Code Than the Product Org Uses In Its Build
- Incentive Alignment
- Change the Developers Mindset
- Share Your Code to Get More Done - Likely Contributors Variant
- Donut 3: How to Defeat the Hierarchical Constraints
- Donut 4: Modular Code (for reuse) Requires Extra Resources
- Donut 5: Project Management Time Pressures
- Donut 6: Organizational Mindset Change
- Donut 8: Not Invented Here
- Donut: Bad Weather For Liftoff
- Get Contributions Despite Silo Thinking
The topics below cover information about how we define, operate, and upkeep this collection of patterns.
- Pattern Template - Start a new pattern with a copy of this
- Pattern States - Definitions of the various states and review steps a pattern can be in
- Trusted Collaborators - Who these people are, what elevated rights they get, and how you can become one
- Publishing - How we take completed, reviewed, proven patterns and publish them toward an online book
- Markdown Info - Markdown is the ascii text format our patterns are written in; this document briefly defines how we use it
- Contributing - 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 - If you want to contribute a pattern using
git
from the command-line, this is your document - Meetings - Become involved with the people and communications of the Inner Source Patterns group
- Alternate Command-line steps - If you want to contribute a pattern using
InnerSourcePatterns by InnerSourceCommons.org is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.