Skip to content

Commit c342b8f

Browse files
committed
Grammar, flow, image, next steps
Updated Grammar, flow, etc; brought over image; linked to next steps (reviewing)
1 parent b52a0e1 commit c342b8f

File tree

2 files changed

+32
-33
lines changed

2 files changed

+32
-33
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Like the command-line better? *As an alternative, you can utilize git's native c
3737

3838
## Use Branches When Creating New Patterns
3939
We develop new patterns in branches with the naming convention:
40-
`pattern/[title-of-pattern-here]`.
40+
`pattern/<title-of-pattern-here>`.
4141

4242
If you are asked to 'Commit directly...' vs 'Create a new branch...'
4343

@@ -67,9 +67,6 @@ After this process, it is our turn to drive you through the pattern creation pro
6767

6868
FIXME: The below content is wrong for this section. Content for this section needs to be written, and the below content needs to be integrated elsewhere (it has some useful info).
6969

70-
![branch, commit, pull request, review](assets/img/branchCommitPullReview.png)
71-
72-
The basic steps below can be thought of as *branch*, *commit*, *pull request*, and *review*.
7370

7471
1. [Create an issue](https://github.com/paypal/InnerSourcePatterns/issues) for each new idea, donut or pattern. The issue should:
7572
* contain a title of the pattern in format ex: ``pattern/badly-named-piles``

meta/technical-git-howto.md

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,33 @@
11
# Command-line git steps for creating a new Pattern
22

3-
If you want to contribute, the workflow is done through branches. You can see the
4-
available branches of this repository at [the branches URL](https://github.com/paypal/InnerSourcePatterns/branches)
5-
or by clicking on the 'branches' button on the main page.
6-
7-
Branches and Pull Requests (PR's) are used to bring discussion/review about a specific inner source pattern.
8-
New patterns should use, as a first approach, the
9-
[pattern template](meta/pattern-template.md). There are indeed multiple ways to start a discussion:
10-
* Pull request your branch and the maintainers will receive a notification.
11-
* Ask directly for comments to some of the maintainers. You can mention them
12-
using the symbol '@' prior their nickname.
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/paypal/InnerSourcePatterns/branches/all) and existing PR's on the [Pull Request page](https://github.com/paypal/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.
4+
5+
There are indeed multiple ways to start a discussion:
6+
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.
139
* Add reviewers to the Pull Request on the website - this sends requests to review your work
1410

15-
Please, when starting a new pattern, be aware that this does not exist. You can
16-
have a look at some of the existing patterns in this repository.
11+
New patterns should use, as their base, the [pattern template file](https://raw.githubusercontent.com/paypal/InnerSourcePatterns/master/meta/pattern-template.md).
12+
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](https://github.com/paypal/InnerSourcePatterns#reviewed-patterns-proven-and-reviewed).
14+
15+
## Overview of steps
16+
17+
![branch, commit, pull request, review](assets/img/branchCommitPullReview.png)
1718

18-
## How can you create a branch?
19+
The basic steps below can be thought of as *branch*, *commit*, *pull request*, and *review*.
1920

20-
In first place you need to create a branch (no need to ask for permission!).
21-
For this, let's clone the repository:
21+
22+
## How do you create a branch?
23+
24+
First you need to create a branch (no need to ask for permission!). For this, let's clone the repository:
2225

2326
```
2427
$ git clone https://github.com/paypal/InnerSourcePatterns.git
2528
```
2629

27-
Then you should see some message similar to the following one:
30+
Then you should see a message similar to the following one:
2831

2932
```
3033
Cloning into 'InnerSourcePatterns'...
@@ -35,8 +38,7 @@ Unpacking objects: 100% (73/73), done.
3538
Checking connectivity... done.
3639
```
3740

38-
This means that you successfully cloned the repository. Then we need to access
39-
the directory and check that everything is as expected.
41+
This means that you successfully cloned the repository. Then we need to access the directory and check that everything is as expected.
4042

4143
```
4244
$ cd InnerSourcePatterns/
@@ -55,38 +57,38 @@ $ git branch -a
5557
```
5658

5759
The command 'git branch' shows you which branch you are currently working within.
58-
And with 'git branch -a' you see additional branches which are local and remote (on the web).
60+
And with 'git branch -a' you see additional branches which are local (on desktop) and remote (on the web).
5961
There is extra information using the command '$ man git branch' in linux based systems.
6062

6163
Next, in order to create a new branch as a way to start creating a new pattern,
6264
you need to 'checkout' that branch. As a common nomenclature, all of the
63-
pattern-related branches should start with the keyword 'pattern/'. Thus, a new
65+
pattern-related branches should start with the keyword `pattern/`. Thus, a new
6466
branch with a new pattern named as foo should be as follows:
6567

6668
```
6769
$ git checkout -b pattern/foo
6870
```
6971

7072
You are now in the 'pattern/foo' branch. When you create a new branch, the files
71-
in the directory might appear change. Each branch can have slightly different content,
72-
and that is intentional. If you need to go again to the 'master' branch or another
73-
branch, you can easily 'checkout' to those as follows:
73+
in the directory might appear to have changed. Each branch can have slightly different content, and that is intentional. If you need to go back to the 'master' branch or another branch, you can easily 'checkout' to those as follows:
7474

7575
```
7676
$ git checkout <branchname>
7777
```
7878

7979
## Adding a new pattern
8080

81-
Let's imagine we want to work a new pattern related to the activities of the
82-
Ewoks that for some reason gave up hunting. We should choose some initial
83-
name for this pattern file that could be 'ewoks-do-not-hunt.md'.
81+
Let's imagine we want to create a new pattern related to the activities of the
82+
Ewoks - they gave up hunting for some reason. We should choose some initial
83+
name for this pattern file. We will use 'ewoks-do-not-hunt.md'.
8484

8585
```
8686
$ git checkout -b pattern/ewoks-do-not-hunt
8787
$ touch ewoks-do-not-hunt.md
8888
```
8989

90+
You can fill your [markdown](meta/markdown-info.md) file with the [pattern template text](https://raw.githubusercontent.com/paypal/InnerSourcePatterns/master/meta/pattern-template.md) and begin to fill it in with your pattern.
91+
9092
Once our pattern file is ready to go, we need to add the file to the repo and
9193
commit that change to our new branch.
9294

@@ -101,6 +103,6 @@ And we should finally upload that branch and file to the server.
101103
$ git push origin pattern/ewoks-do-not-hunt
102104
```
103105

104-
Then, if you feel the pattern is ready to review, you can start a Pull Request (PR) asking
105-
to join your new branch to the master branch. To do this, navigate to the github web repo
106-
and get into your new branch. You should see a 'Create pull request' button while in your branch.
106+
Then, if you feel the pattern is ready to be reviewed, you can start a Pull Request (PR) asking to join your new branch to the github master branch. To do this, navigate to the github web repo and get into your new branch. You should see a 'Create pull request' button while in your branch.
107+
108+
PR's are the mechanism we use for our multi-step Review process. See next steps in [Interacting with Pattern Reviews](CONTRIBUTING.md#c-interacting-with-patterns-reviews).

0 commit comments

Comments
 (0)