You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+29-20Lines changed: 29 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,21 +18,21 @@ Select one of the following ways to contribute, to learn our workflow:
18
18
19
19
# A. Writing a New Pattern
20
20
21
-
The below steps can be used to create a new `donut`, `idea`, or complete pattern. The use-case here is that you have a relatively thought-out idea or problem in your head and can confidently fill out the barest of pattern fields (Solution doesn't need to be known). If you are unsure your idea is ready for this, [discuss it in an issue first](#b-discussing-early-ideas-in-issues).
21
+
The below steps can be used to create a new pattern. The use-case here is that you have an idea or problem in your head and can confidently fill out the barest of pattern fields (Solution doesn't need to be known). If you are unsure your idea is ready for this, [discuss it in an issue first](#b-discussing-early-ideas-in-issues).
22
22
23
-
The simplest way to create a pattern is with your browser:
23
+
The simplest way to create a pattern is with your browser (see below).
24
+
[Like the command-line better? See here for alternate instructions.](/meta/technical-git-howto.md)
24
25
25
-
1. Assure you are logged into GitHub & go to the [patterns web repo](https://github.com/paypal/InnerSourcePatterns)
26
-
2. Click on the 'Create new file' button
27
-
3. Name the file like this example: "project-management-time-pressures.md"
28
-
4. Use the [pattern template](https://raw.githubusercontent.com/paypal/InnerSourcePatterns/master/meta/pattern-template.md) to create your new [markdown](/meta/markdown-info.md) file with the description of your _idea_, _donut_, or _pattern_
29
-
5. Enter a commit message
30
-
* If you are asked to 'Commit directly' vs 'Create a new branch', see [branching details](#use-branches-when-creating-new-patterns) below.
31
-
6. Propose this new file and then also create a Pull Request (PR)
26
+

32
27
33
-
Your done! This creates a separate branch and creates a Pull Request (PR) all in one fell swoop! PR's are the mechanism we use for our multi-step Review process. See next steps in [Interacting with Pattern Reviews](#c-interacting-with-patterns-reviews).
28
+
1. Login to GitHub & inside the [patterns web repo](https://github.com/paypal/InnerSourcePatterns), click on the 'Create new file' button
29
+
2. Name the file like this example: "project-management-time-pressures.md"
30
+
3. Use the [pattern template](https://raw.githubusercontent.com/paypal/InnerSourcePatterns/master/meta/pattern-template.md) to create your new [markdown](/meta/markdown-info.md) file with the description of your fledgling pattern; it does not need to be complete, as you can add to it later
31
+
4. Enter a commit message
32
+
* If you are asked to 'Commit directly' vs 'Create a new branch', see [branching details](#use-branches-when-creating-new-patterns) below.
33
+
5. Propose this new file and then also create a Pull Request (PR)
34
34
35
-
Like the command-line better? *As an alternative, you can utilize git's native command line instead*. [We have a separate set of technical instructions here](/meta/technical-git-howto.md).
35
+
Your done! This creates a separate branch and creates a Pull Request (PR) all in one fell swoop! PR's are the mechanism we use for our Review process. See next steps in [Interacting with Pattern Reviews](#c-interacting-with-patterns-reviews).
36
36
37
37
38
38
## Use Branches When Creating New Patterns
@@ -65,18 +65,27 @@ After this process, it is our turn to drive you through the pattern creation pro
65
65
66
66
# C. Interacting with Patterns Reviews
67
67
68
-
A pattern is said to be "in-review" or being "Reviewed" when we have a Pull Request with some amount of Pattern detail filled out. We then communally review, and comment-on, and OK these "in-review" patterns. There are multiple steps involved, sometimes requiring multiple re-writes, and peer-reviews. Usually though, we first look for a pattern with all the fields filled out, and then go through TWO peer-reviews.
68
+
A pattern is said to be "in-review" or being "Reviewed" when we have a Pull Request with some amount of Pattern detail filled out. We then communally review, and comment-on, and OK these "in-review" patterns. Usually, we first look for a pattern with all the fields filled out, and then go through TWO peer-reviews.
69
+
70
+
## Editing a pattern that is in-review
71
+
Go ahead, edit away - we can always go back - and we encourage action over discussion.
72
+
73
+

69
74
70
-
Our workflow is done through Pull Requests (PR's) and Branches. Branches are meant to separate content, so that multiple people and patterns can exist all at once. Pull Requests (PR's) are used to bring online discussion/review about a specific Inner Source pattern.
75
+
## Reviewing a pattern
76
+
FIXME Explain how to add review comments and accepting a review. Basically, this is all done through Githubs web GUI around Pull Requests.
71
77
72
-
FIXME Explain how to add content to in-review patterns. Explain how to add review comments and accepting a review.
78
+
FIXME Give tips for good reviews. We have done both interspersed comments, or patter-wide advise. Be constructive. If you can fix the problem, [edit the PR](#editing-a-pattern-that-is-in-review) instead of leaving a comment.
73
79
74
-
Below are the major steps in our Review process:
80
+
## Our Review Process
81
+
Below are the procedural steps in our Review process:
75
82
76
-
1. Label your Pull Request with `pattern`. Additionally decide whether to label it with `idea`, `donut`, or `draft` and `Ready for Review` or `Incomplete`
77
-
2. Reviewers can now use the PR features to comment on the pattern.
78
-
3. In case of required rework, the author should apply the labels `Ready for Additional Review` and/or `Revised` to indicate that a 2nd review is requested.
79
-
4. After reviews are complete, the reviewers or author should remove the label `Ready for Review` and label the pattern `Accepted`.
80
-
5. Once a pattern is `Accepted` by the reviewers, one of the [Trusted Collaborators](/meta/trusted-collaborators.md) (most authors are by this point) can Merge the PR on Github. This places the .md file into the master branch / root directory.
83
+
1. Decide which Maturity level your pattern is in: `Donut (Lacks solution)`, `Unproven`, or `Proven`; these all describe what state the *Solution* is in.
84
+
2. Decide which Review Step you are in: Usually `Incomplete` or `Do 1st Review`
85
+
3. Reviewers can now use the PR features to comment on the pattern.
86
+
4. In most cases, we do two reviews, and the PR's labels should reflect `Do 2nd Review` etc.
87
+
5. After reviews are complete, the reviewers or author should Revise and Finalize the pattern, eventually labeling it with `Accepted`.
88
+
6. Once a pattern is `Accepted` by the reviewers, one of the [Trusted Collaborators](/meta/trusted-collaborators.md) (most authors are by this point) can Merge the PR on Github. This places the .md file into the master branch / root directory.
81
89
90
+
## Completed Patterns
82
91
When completed patterns (reviewed and accepted) are ready to be published from this InnerSourcePatterns repo to a Gitbook (PDF), [see our separate Publishing instructions](/meta/publishing.md).
0 commit comments