Skip to content

Commit 2892910

Browse files
authored
Merge pull request #264 from nschonni/markdownlint-whitespace
fix: Markdownlint rules for whitespace
2 parents d139254 + 3964d28 commit 2892910

35 files changed

+171
-69
lines changed

.markdownlint.json

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,13 @@
22
"default": true,
33
"MD004": false,
44
"MD007": false,
5-
"MD009": false,
6-
"MD012": false,
75
"MD013": false,
86
"MD014": false,
9-
"MD022": false,
107
"MD024": false,
118
"MD025": false,
129
"MD026": false,
1310
"MD029": false,
1411
"MD030": false,
15-
"MD032": false,
1612
"MD033": false,
1713
"MD034": false,
1814
"MD036": false,

CONTRIBUTING.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ The goal of the InnerSource patterns working group is to collect, document, and
44

55
For this working group to strive, we welcome your contribution - be it small or huge.
66

7-
87
## How to Contribute?
98

109
Please consider contributing in the following ways:
@@ -19,7 +18,6 @@ Please consider contributing in the following ways:
1918

2019
5. **Be a patterns advocate.** The patterns will become better and cover more topics the more people contribute their perspective and experience. A colleague told you about a novel InnerSource best practice? Please invite her/him to contribute to this repository!
2120

22-
2321
## How to get in touch?
2422

2523
We are happy to support you in contributing to the InnerSource patterns or to just chat with you. You can reach out to us in the following ways:
@@ -28,12 +26,10 @@ We are happy to support you in contributing to the InnerSource patterns or to ju
2826

2927
2. **During the patterns office hours.** We established a regular cadence of office hours for you to ask questions. Find the date of the next patterns office hours [in this calendar](https://innersourcecommons.org/patterns-officehours).
3028

31-
3229
## License of Contributions
3330

3431
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.
3532

36-
3733
## Code of Conduct
3834

3935
We do not yet have a fully formalized code of conduct yet. We expect all contributors to treat each other respectfully and help us to keep this community free of harassment and discrimination.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ You are already using InnerSource in your company and want to share your ideas a
1111
## Mission Statement
1212

1313
Our mission in this working group
14+
1415
- Collect and document agreed upon best practices of how to do InnerSource - in the form of patterns
1516
- Continuously publish the most mature patterns as an ebook
1617

meta/FAQ.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
This is a list of frequently asked questions about InnerSource Patterns
22

33
## What are the different parts of a pattern? What do they mean?
4+
45
* See the [pattern template](pattern-template.md) (in the *meta* subdirectory)
56

67
## Why use a patterns approach to InnerSource?
8+
79
* It abstracts information from known instances of proven solutions so that other people/companies can understand not only what was done by why it worked and how to adapt it to their own situations.
810

911
## How do you use the pattern?
12+
1013
* Each organization has its own history (*context*) and culture (a source of *forces*) and even goals, so using a pattern to solve their problems will generally require adaptation of that pattern. Try to identify things about your situation that are unique and apply those as makes sense to the *Context* and *Forces* identified in the pattern. See if these additional constraints might require changes to the *Solution* to ensure that the pattern will work.
1114
* Patterns can also be used as a short-hand when discussing InnerSource programs across organizational boundaries.
1215

1316
## I'd like to consult with the IS Patterns community; do I need to have participating members sign NDAs?
17+
1418
* You could do that, but be aware that the vast majority of IS Patterns meetings are held under the [Chatham House Rule](https://www.chathamhouse.org/chatham-house-rule) that should provide sufficient protection to enable a productive discussion.

meta/boardreports/2020-10-details.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# InnerSource Patterns WG - Report for governance meeting 2020-10
22

33
**Details Section**
4-
4+
55
## Project Activity - Describe the overall activity in the project over the past quarter.
66

77
Here are some more detailed numbers as mentioned in short-form.
@@ -10,10 +10,10 @@ Here are some more detailed numbers as mentioned in short-form.
1010

1111
#### Entirely new & merged: 5
1212

13-
- RFCs #204 @tsadler1988 @spier @mainec
13+
- RFCs #204 @tsadler1988 @spier @mainec
1414
- InnerSource Activity Score @michadelic SAP #189 @newmexicokid @spier
1515
- InnerSource License #147
16-
- Pattern Overview Mindmap: @feiwan2000 (very popular!)
16+
- Pattern Overview Mindmap: @feiwan2000 (very popular!)
1717
- Europace sponsored: Mechanics and tooling recommendations #124, #123 #121 @mainec @rrutledge @martinklewitz @newmexicokid @sjn
1818

1919
#### Entirely new & open: 2
@@ -29,7 +29,7 @@ Here are some more detailed numbers as mentioned in short-form.
2929

3030
#### Progress on existing PRs: 8
3131

32-
- #95 (almost done, @gruetter), #46 (#216, @gruetter) #120 #84 #78 #74 #71 #64
32+
- #95 (almost done, @gruetter), #46 (#216, @gruetter) #120 #84 #78 #74 #71 #64
3333

3434
### Technical contributions: about 8
3535

@@ -39,7 +39,7 @@ Here are some more detailed numbers as mentioned in short-form.
3939

4040
### Cleanup, Fixing & Migration: a lot
4141

42-
- Fixing countless typos, broken links and inconsistent templates/documentation: @spier
42+
- Fixing countless typos, broken links and inconsistent templates/documentation: @spier
4343
- Spelling, typos, examples #176, #175 @jpatrao
4444
- Typos, small improvements @stingrayza, @michadelic @funzinator
4545

meta/boardreports/2020-10.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
## Project Activity - Describe the overall activity in the project over the past quarter.
1616

1717
- New process proposal by @maxcapraro, discussion (@spier @mainec @newmexicokid @lenucksi) and successful adoption (initial, structured, validated, goal: faster first contribution, see contributor handbook)
18-
- 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.
18+
- 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.
1919
- Great work towards content rendering (e.g. website, initial PDFs) in progress @spier @dizquerdo (https://innersourcecommons.gitbook.io/innersource-patterns-staging/v/book/)
20-
- Conference activity, more, interesting pattern activity on Slack leading to new patterns
20+
- Conference activity, more, interesting pattern activity on Slack leading to new patterns
2121
- Patterns office-hours concept try out, some success, dual time-zone meeting concept successfully in use in marketing wg
2222

2323
### Pattern-work

meta/boardreports/2020-11.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
- 1 new contributor in the reporting period (@WillemJiang)
1919
- Challenges:
20-
- PRs with minor changes stay open for extended periods. This prevents quick incremental quality improvements. This might also demotivate contributors, as giving them a sense of success would be a way to keep them engaged in the project. Examples: [#213](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/213), [#222](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/222), [#230](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/230), [#232](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/232)
20+
- PRs with minor changes stay open for extended periods. This prevents quick incremental quality improvements. This might also demotivate contributors, as giving them a sense of success would be a way to keep them engaged in the project. Examples: [#213](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/213), [#222](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/222), [#230](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/230), [#232](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/232)
2121
- Also the longer a PR stays open, the higher the chances that that PR will go stale i.e. the author does not have time anymore to see the PR through. Examples of said risk are [13 PRs](https://github.com/InnerSourceCommons/InnerSourcePatterns/pulls?q=is%3Apr+is%3Aopen+created%3A%3C2020) that have been created prior to 2020, many even in 2017. Bringing these PRs to a stage where they can either be discontinued (i.e. closed) or approved+merged has proven difficult.
2222
- Activity and trusted committer diversity is too low to sustain the project in the long run on a high activity level. (Low activity evolution is sustainable.)
2323

meta/boardreports/2020-12.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
- 2 new and new-ish contributors in the reporting period ([@WillemJiang](https://github.com/WillemJiang), [@MelindaMalmgren](https://github.com/MelindaMalmgren))
1919
- Challenges: (same as in the [last report](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/master/meta/boardreports/2020-11.md#projectcommunity-status-and-health))
20-
- PRs with minor changes stay open for extended periods. This prevents quick incremental quality improvements. This might also demotivate contributors, as giving them a sense of success would be a way to keep them engaged in the project. Examples: [#213](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/213), [#222](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/222), [#230](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/230), [#232](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/232)
20+
- PRs with minor changes stay open for extended periods. This prevents quick incremental quality improvements. This might also demotivate contributors, as giving them a sense of success would be a way to keep them engaged in the project. Examples: [#213](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/213), [#222](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/222), [#230](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/230), [#232](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/232)
2121
- Also the longer a PR stays open, the higher the chances that that PR will go stale i.e. the author does not have time anymore to see the PR through. Examples of said risk are [13 PRs](https://github.com/InnerSourceCommons/InnerSourcePatterns/pulls?q=is%3Apr+is%3Aopen+created%3A%3C2020) that have been created prior to 2020, many even in 2017. Bringing these PRs to a stage where they can either be discontinued (i.e. closed) or approved+merged has proven difficult.
2222
- Activity and trusted committer diversity is too low to sustain the project in the long run on a high activity level. (Low activity evolution is sustainable.)
2323

meta/contributor-handbook.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,39 +14,36 @@ We have defined three maturity levels for patterns: The higher a pattern's matur
1414
| 2 | Structured | Contains a complete pattern that it is not properly validated yet (e.g. because it only synthesizes an idea or the experiences from one instead of three organizations). | A few days / weeks |
1515
| 3 | Validated | The pattern is validated (e.g. because three or more instances exists and are synthesized by the pattern) and its writing is of high quality. | A few months |
1616

17-
For the first pattern you contribute, you should aim for maturity levels `1: Initial` or `2: Structured`.
17+
For the first pattern you contribute, you should aim for maturity levels `1: Initial` or `2: Structured`.
1818

1919
If you want to help promoting a pattern one maturity level up, we suggest to first create an issue to discuss the matter and see if someone else is working on that already. After that, you can create a pull request with the necessary changes.
2020

2121
To achieve a given maturity level a pattern has to satisfy the requirements for that given maturity level and lower levels. The following sections lay out the requirements per maturity level in detail.
2222

23-
2423
### Requirements: Level 1 - Initial
2524

2625
Patterns (or other documents) of level 1 are stored in the directory `/patterns/1-initial`.
2726

2827
- Validation requirements:
2928
- N/A
30-
29+
3130
- Content requirements:
3231
- The document is readible & comprehensible for other parties (not just for the author(s))
3332
- The author(s) contribute the contents according to the [license](../LICENSE.txt) & are allowed to do so
3433
- Thoughts and contents by third parties are quoted / referenced explicitly
3534

36-
3735
### Requirements: Level 2 - Structured
3836

3937
Patterns of level 2 are stored in the directory `/patterns/2-structured`.
4038

4139
- Validation requirements:
42-
- Is validated by at least one known instance
40+
- Is validated by at least one known instance
4341
- Alternatively: key elements of the pattern have been validated in separate contexts and, in consequence, it is justified to believe the full solution will function
44-
42+
4543
- Content requirements:
4644
- Complies with the [patterns format](pattern-template.md)
4745
- Complies with *basic style guide*(#) - *Oops! We have not yet developed this*
48-
49-
46+
5047
### Requirements: Level 3 - Validated
5148

5249
Patterns of level 3 are stored in the directory `/patterns/3-validated`.
@@ -55,7 +52,7 @@ Patterns of level 3 are stored in the directory `/patterns/3-validated`.
5552
- Is validated by at least three known instances
5653
- Considers all known instances to the best of working group members' knowledge
5754
- Community agreement (via lazy consensus of trusted committers) on correctness of contents
58-
55+
5956
- Content requirements:
6057
- Uses & has no conflicts with working group terminology (defined by glossary / implicit usage) - *Oops! We have not yet developed this.*
6158
- Fits & has no conflicts with existing patterns (of this maturity level or higher)

meta/innersource-spelling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ We encourage you to use the word as a proper noun (like “We use InnerSource in
1010

1111
We favor the spelling **InnerSource**, for the following reasons:
1212

13-
1. That’s the way Tim O’Reilly [spelled it in 2000][opengl_1200] (he was into Perl and camel-case was a thing). Also see the [Foreword of the Adopting InnerSource book][foreword_AdoptingInnerSource] for more of Tim O’Reilly's own words on the topic.
13+
1. That’s the way Tim O’Reilly [spelled it in 2000][opengl_1200] (he was into Perl and camel-case was a thing). Also see the [Foreword of the Adopting InnerSource book][foreword_AdoptingInnerSource] for more of Tim O’Reilly's own words on the topic.
1414
2. If you set up side-by-side Google searches for “Inner Source” and “InnerSource” you will find that you get more hits on the former term, by only 1% of them have anything to do with what we call InnerSource. The latter term will be 100% cogent to your inquiry.
1515
3. The OSI was [denied trademark on the term “open source”][no-open-source-trademark] because it was made up of two common and unrelated terms. “InnerSource” on the other hand is a new word.
1616

0 commit comments

Comments
 (0)