Skip to content

Commit f152215

Browse files
authored
Some cleanup in the 'meta' folder (#274)
Cleanup in the 'meta' folder. Improve FAQ, meta/README and git commandline steps. Deleted unused images.
1 parent 89a9bcd commit f152215

4 files changed

Lines changed: 33 additions & 20 deletions

File tree

-103 KB
Binary file not shown.

meta/FAQ.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
This is a list of frequently asked questions about InnerSource Patterns
1+
# InnerSource Patterns FAQ
2+
3+
This is a list of frequently asked questions about InnerSource Patterns.
24

35
## What are the different parts of a pattern? What do they mean?
46

5-
* See the [pattern template](pattern-template.md) (in the *meta* subdirectory)
7+
* See the [pattern template](pattern-template.md)
68

79
## Why use a patterns approach to InnerSource?
810

@@ -13,6 +15,7 @@ This is a list of frequently asked questions about InnerSource Patterns
1315
* 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.
1416
* Patterns can also be used as a short-hand when discussing InnerSource programs across organizational boundaries.
1517

16-
## I'd like to consult with the IS Patterns community; do I need to have participating members sign NDAs?
18+
## I'd like to consult with the InnerSource Patterns community; do I need to have participating members sign NDAs?
1719

18-
* 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.
20+
* The vast majority of InnerSource Patterns meetings and all conversations in the InnerSource Commons [Slack](https://isc-inviter.herokuapp.com/) are held under the [Chatham House Rule](https://www.chathamhouse.org/chatham-house-rule) that should provide sufficient protection to enable a productive discussion.
21+
* To answer the question directly: No, you don't have to get NDAs signed :)

meta/README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,16 @@
22

33
The topics below cover information about how we define, operate, and upkeep this collection of patterns.
44

5-
* [Pattern Template](./pattern-template.md) - Start a new pattern with a copy of this
5+
* [Contributing](../CONTRIBUTING.md) - How to interact with our group, create your own patterns, or take part in our review-process; GitHub / Web centric instructions
6+
* [Alternate Command-line steps](./technical-git-howto.md) - Contribute a pattern using `git` from the command-line
67
* [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.
7-
* **(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.
8+
* [Pattern Template](./pattern-template.md) - Start a new pattern with a copy of this
9+
* [FAQ](./FAQ.md) - Frequently asked questions about InnerSource Patterns
810
* [Trusted Committers](../TRUSTED-COMMITTERS.md) - Who these people are, what elevated rights they get, and how you can become one
911
* [Markdown Info](./markdown-info.md) - Markdown is the ascii text format our patterns are written in; this document briefly defines how we use it
10-
* [Contributing](../CONTRIBUTING.md) - How to interact with our group, create your own patterns, or take part in our review-process; Github / Web centric instructions
11-
* [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
12+
13+
## Unfinished documentation
14+
1215
* **(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.
1316
* [InnerSource Spelling](./innersource-spelling.md) - Clarifies the mystery around how to spell this. Spoiler: It is **InnerSource**.
14-
* [FAQ](./FAQ.md) - Frequently asked questions about InnerSource Patterns
17+
* **(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.

meta/technical-git-howto.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
# Command-line git steps for creating a new Pattern
22

3-
If you want to contribute a new pattern, the workflow is done through Branches and Pull Requests (PR's). You can see the available branches on [the branches URL](https://github.com/InnerSourceCommons/InnerSourcePatterns/branches/all) and existing PR's on the [Pull Request page](https://github.com/InnerSourceCommons/InnerSourcePatterns/pulls). Branches are meant to separate content, so that multiple people can work all at once. Pull Requests (PR's) are used to bring discussion/review about a specific inner source pattern.
3+
If you want to contribute a new pattern, the workflow is support by these important concepts:
44

5-
There are indeed multiple ways to start a discussion:
5+
* [Branches](https://github.com/InnerSourceCommons/InnerSourcePatterns/branches/all) are meant to separate content, so that multiple people can work all at once.
6+
* [Pull Requests](https://github.com/InnerSourceCommons/InnerSourcePatterns/pulls) (PR's) are used for discussion/review of a specific InnerSource pattern.
67

7-
* Send a Pull Request for your branch and the maintainers will receive a notification.
8-
* Create an Issue and ask for comments from some of the maintainers. You can mention them using the '@' symbol prior to their github nickname.
9-
* Add reviewers to the Pull Request on the website - this sends requests to review your work
8+
There are multiple ways to start a discussion:
109

11-
New patterns should use, as their base, the [pattern template file](pattern-template.md).
10+
* Fork the repo, create a branch, and then send a Pull Request for your branch. The maintainers will receive a notification about this automatically.
11+
* Create an [Issue](https://github.com/InnerSourceCommons/InnerSourcePatterns/issues) and ask for comments from some of the [Trusted Committers](../TRUSTED-COMMITTERS.md). You can mention them using the '@' symbol prior to their GitHub username.
12+
* Add reviewers to your Pull Request in GitHub - this sends requests to review your work
1213

13-
Please, when starting a new pattern, make sure that it does not already exist. Take a look at some of the [existing patterns in this repository](/README.md#reviewed-patterns-proven-and-reviewed).
14+
New patterns should use the [pattern template file](pattern-template.md) as their starting point.
15+
16+
When starting a new pattern, make sure that it does not already exist. Take a look at the [existing patterns in this repository](/README.md#list-of-patterns).
1417

1518
## Overview of steps
1619

@@ -20,10 +23,14 @@ The basic steps below can be thought of as *branch*, *commit*, *pull request*, a
2023

2124
## How do you create a branch?
2225

23-
First you need to create a branch (no need to ask for permission!). For this, let's clone the repository:
26+
First you need to create a branch (no need to ask for permission!).
27+
28+
For this, [create a fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) of this repository.
29+
30+
Then create a [local clone of your fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-a-local-clone-of-your-fork).
2431

2532
```
26-
$ git clone https://github.com/InnerSourceCommons/InnerSourcePatterns.git
33+
$ git clone https://github.com/YOUR-USERNAME/InnerSourcePatterns.git
2734
```
2835

2936
Then you should see a message similar to the following one:
@@ -86,7 +93,7 @@ $ git checkout -b pattern/ewoks-do-not-hunt
8693
$ touch patterns/1-initial/ewoks-do-not-hunt.md
8794
```
8895

89-
You can fill your [markdown](markdown-info.md) file with the [pattern template text](pattern-template.md) and begin to fill it in with your pattern.
96+
We then fill our [markdown](markdown-info.md) file with the [pattern template text](pattern-template.md) and start to write our pattern.
9097

9198
Once our pattern file is ready to go, we need to add the file to the repo and
9299
commit that change to our new branch.
@@ -96,7 +103,7 @@ $ git add patterns/1-initial/ewoks-do-not-hunt.md
96103
$ git commit -m "InnerSource Pattern to deal with Ewoks that do not hunt"
97104
```
98105

99-
And we should finally upload that branch and file to the server.
106+
And finally we upload that branch and file to the server.
100107

101108
```
102109
$ git push origin pattern/ewoks-do-not-hunt

0 commit comments

Comments
 (0)