Skip to content

Commit 99439ab

Browse files
committed
Separate section for 'List of Patterns'
Got the patterns list into its own section and then subsections; Prior to this, they were just there at the root level, now they are under a parent Heading called ‘List of Patterns’ Also fixed spacing and changed header type to match CONTRIB.md
1 parent 6609531 commit 99439ab

File tree

1 file changed

+13
-18
lines changed

1 file changed

+13
-18
lines changed

README.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
This repository serves as the collection-point, ideation hub, and process behind the [InnerSource Commons'](http://innersourcecommons.com) set of proven and reviewed InnerSource approaches (patterns). These patterns illustrate beneficial activities and behaviors found in [organizations who apply InnerSource methodologies](http://paypal.github.io/InnerSourceCommons/getting-started/).
22

3-
What are Inner Source Patterns?
4-
===============================
3+
4+
# What are Inner Source Patterns?
55

66
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.
77

@@ -10,16 +10,14 @@ Patterns are a way of describing a repeatable, proven solution to a problem with
1010
* [View our InnerSource Patterns Template](meta/pattern-template.md)
1111

1212

13-
How can you use Inner Source Patterns?
14-
======================================
13+
# How can you use Inner Source Patterns?
1514

1615
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.
1716

1817
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).
1918

2019

21-
How to Contribute?
22-
==================
20+
# How to Contribute?
2321

2422
[See our CONTRIBUTING.md for details on getting involved](CONTRIBUTING.md)
2523

@@ -28,14 +26,15 @@ We encourage beginners seeking answers to jump in by creating ''donuts'' (proble
2826
We work together via Github, Webex, Slack, etc. Do not hesitate to join the [#innersourcecommons](https://isc-inviter.herokuapp.com/) or #innersource-patterns slack channels and ask to be included in the [patterns meetings](/meta/meetings.md) (there is an email list).
2927

3028

31-
Reviewed Patterns (proven and reviewed)
32-
=======================================
29+
30+
# List of Patterns
31+
32+
## Reviewed Patterns (proven and reviewed)
3333

3434
* [Contracted Contributor](https://github.com/paypal/InnerSourcePatterns/blob/master/contracted-contributor.md)
3535
* [Dedicated Community Leader](https://github.com/paypal/InnerSourcePatterns/blob/master/dedicated-community-leader.md)
3636

37-
Pattern Drafts (proven, not yet reviewed)
38-
=========================================
37+
## Pattern Drafts (proven, not yet reviewed)
3938

4039
* [Common Requirements](https://github.com/paypal/InnerSourcePatterns/pull/11)
4140
* [Reluctance to receive contributions](https://docs.google.com/document/d/13QDN-BpE_BixRFVGjao32n4Ctim0ROXAHbBWMBOijb4/edit)
@@ -47,8 +46,7 @@ Pattern Drafts (proven, not yet reviewed)
4746
* [Open Source trumps InnerSource](https://github.com/paypal/InnerSourceCommons/wiki/Open-Source-trumps-InnerSource)
4847
* [Overcoming Project Management Time Pressures](https://github.com/paypal/InnerSourceCommons/wiki/Draft-Pattern---Overcoming-Project-Management-Time-Pressures)
4948

50-
Pattern Ideas (not yet proven; brainstormed)
51-
============================================
49+
## Pattern Ideas (not yet proven; brainstormed)
5250

5351
* [Badly named piles](https://github.com/paypal/InnerSourcePatterns/blob/master/badly-named-piles.md)
5452
* [Don't bother looking](https://github.com/paypal/InnerSourcePatterns/blob/master/dont-bother-looking.md)
@@ -58,8 +56,7 @@ Pattern Ideas (not yet proven; brainstormed)
5856
* [Change the developers mindset](https://github.com/paypal/InnerSourceCommons/wiki/Pattern:-change-the-developers-mindset)
5957
* [Share Your Code to Get More Done - Likely Contributors Variant](https://github.com/paypal/InnerSourceCommons/wiki/Pattern:-Share-Your-Code-to-Get-More-Done---Likely-Contributors-Variant)
6058

61-
Pattern Donuts (needing a solution)
62-
===================================
59+
## Pattern Donuts (needing a solution)
6360

6461
* [Donut 3: how to defeat the hierarchical constraints](https://github.com/paypal/InnerSourceCommons/wiki/Donut-3%3A-how-to-defeat-the-hierarchical-constraints)
6562
* [Donut 4: modular code (for reuse) requires extra resources](https://github.com/paypal/InnerSourceCommons/wiki/Donut-4%3A-modular-code-%28for-reuse%29-requires-extra-resources)
@@ -70,15 +67,13 @@ Pattern Donuts (needing a solution)
7067
* [Get contributions despite silo thinking](https://github.com/paypal/InnerSourcePatterns/pull/38)
7168

7269

73-
Pattern Meta Info
74-
=================
70+
# Pattern Meta Info
7571

7672
* [Pattern States](meta/pattern-states.md) - Definitions of the various states and review steps a pattern can be in
7773
* [Pattern Template](meta/pattern-template.md) - Start a new pattern with a copy of this
7874

7975

80-
Licensing
81-
=========
76+
# Licensing
8277

8378
![Creative Commons License](https://i.creativecommons.org/l/by-sa/4.0/88x31.png)
8479

0 commit comments

Comments
 (0)