Skip to content

Commit ff52dc1

Browse files
committed
Update 'Pattern Reviews' section
Removed steps and added steps; Rewrote sentences and created links; Still need a few critical instructions around how to actually DO reviews (from a reviewers POV)
1 parent ca7f040 commit ff52dc1

File tree

2 files changed

+18
-38
lines changed

2 files changed

+18
-38
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Select one of the following ways to contribute, to learn our workflow:
1818

1919
# A. Writing a New Pattern
2020

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. If you are unsure your idea is ready for this, [discuss it in an issue first](#discussing-early-ideas-in-issues).
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](#discussing-early-ideas-in-issues).
2222

2323
The simplest way to create a pattern is with your browser:
2424

@@ -54,8 +54,8 @@ If you feel that you need extra advice when dealing with patterns, please open a
5454
Here are tips on starting this discussion:
5555

5656
* [Create a new ticket](https://github.com/paypal/InnerSourcePatterns/issues/new).
57-
* Add a concise title to the pattern you would like to discuss.
58-
* Think about the context of your problem and your expected output. Where do you see this problem most? What is the setup of your business and organization? Do you have opinions/ideas on what causes or leads-to the problem?
57+
* Add a concise title like this example: "pattern/badly-named-piles"
58+
* Describe your problem. Think about the context of your problem and your expected output. Where do you see this problem most? What is the setup of your business and organization? Do you have opinions/ideas on what causes or leads-to the problem?
5959
* Ask any questions that you are unsure about. Are you unsure if this problem belongs here? Are you unsure on how to frame and explain the problem?
6060
* [Apply the label](https://help.github.com/articles/applying-labels-to-issues-and-pull-requests/) `Idea`. Labels can be found in the right column settings.
6161

@@ -65,38 +65,18 @@ After this process, it is our turn to drive you through the pattern creation pro
6565

6666
# C. Interacting with Patterns Reviews
6767

68-
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).
69-
70-
71-
1. [Create an issue](https://github.com/paypal/InnerSourcePatterns/issues) for each new idea, donut or pattern. The issue should:
72-
* contain a title of the pattern in format ex: ``pattern/badly-named-piles``
73-
* contain a short description (at least the problem) and
74-
* be labeled with the appropriate label (_idea_, _donut_, _pattern_)
75-
2. Create a new branch either in your browser, clone, or fork of the
76-
[patterns repository][patternsRepo]. Please use the similar convention for
77-
naming branches: `pattern/<pattern-name>`. Example:
78-
`pattern/contracted-contributor`.
79-
3. Create a [Markdown](/meta/markdown-info.md) file with the description of the _idea_, _donut_ or
80-
_pattern_ and store it in the main directory. Commit and push.
81-
4. Once your contribution is ready to be reviewed, create a pull request (PR)
82-
targeted at `master` and label it with _pattern_. Additionally decide whether
83-
to label it with _idea_, _donut_, or _draft_ and _Ready for Review_ or _Incomplete_
84-
5. Reviewers can now use the PR features to comment on the pattern.
85-
6. In case of required rework, the author should apply the labels
86-
_Ready for Additional Review_ and/or _Revised_ to indicate that a 2nd review is requested.
87-
7. After reviews are complete, the reviewers or author should remove the label
88-
_Ready for Review_ and label the pattern _Accepted_.
89-
8. Once a pattern is labeled _Accepted_ by the reviewers, one of the TCs of the
90-
[patterns repository][patternsRepo] will then move the pattern to either the
91-
`ideas`, `donuts` or `patterns` subdirectories, merge it to `master` and
92-
close the associated issue.
93-
94-
When completed patterns (reviewed and accepted) are ready to be published from this InnerSourcePatterns repo to the InnerSourceCommons repo, [see our seperate PUBLISHING.md instructions](PUBLISHING.md).
95-
96-
If you would like [technical command-line instructions, see here](/meta/technical-git-howto.md).
97-
98-
99-
100-
[commons]: http://innersourcecommons.org
101-
[patternsRepo]: https://github.com/paypal/InnerSourcePatterns
102-
[commonsRepo]: https://github.com/paypal/InnerSourceCommons
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.
69+
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.
71+
72+
FIXME Explain how to add content to in-review patterns. Explain how to add review comments and accepting a review.
73+
74+
Below are the major steps in our Review process:
75+
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.
81+
82+
When completed patterns (reviewed and accepted) are ready to be published from this InnerSourcePatterns repo to the InnerSourcePatterns Gitbook, [see our separate PUBLISHING.md instructions](/meta/publishing.md).
File renamed without changes.

0 commit comments

Comments
 (0)