Skip to content

InnerSource Patterns workflow #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 15, 2016
Merged

InnerSource Patterns workflow #8

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8ae027a
#5 InnerSource Patterns workflow
HaRo87 Nov 19, 2016
c9316c3
refined workflow #5
gruetter Nov 19, 2016
0ba2608
added branching instruction (accidentally removed in previous commit) #5
gruetter Nov 19, 2016
ea6acba
added ideas from Georg #5
HaRo87 Nov 23, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# InnerSource Patterns Workflow

This document describes the workflow for writing, reviewing and publishing
InnerSource patterns.

## General information

There are two separate repositories needed for this workflow:

* [InnerSourceCommons](https://github.com/paypal/InnerSourceCommons)
* InnerSourcePatterns [todo: create and add link to repo]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The patterns repo has to be created, right?


### InnerSourcePatterns repository

Inside of this repository we're using the standard GitHub workflow where we
have one main branch - the master branch. Contributions are done via fork and
pull-requests.

### InnerSourceCommons repository

Inside of this repository we're using the standard GitHub workflow where we
have one main branch - the master branch. Contributions are done via fork and
pull-requests. This repository contains the sources for the GitHub pages
website for innersourcecommons.org.

## Workflow description

### Working inside of the InnerSourcePatterns repository

* for each new pattern a new issue should be created
* the issue should contain the name of the pattern,
* a short description (at least the problem) and
* being labeled (pattern-draft, pattern, donut, ...)
* every pattern idea, donut or draft should start on a dedicated branch,
originating from `master` starting with `pattern/[issue-number]---[title]`
* once a pattern idea/donut/draft is ready for review, authors should start a PR
and label it with either `Donut`, `Idea` or `Pattern` and also with
`Ready for Review`
* once a pattern was accepted by the reviewers, it should be labeled `Accepted`
and merged to `master`

### Publishing a InnerSource pattern on innersourcecommons.org (InnerSourceCommons repository)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have to define a place where we want to store the patterns on innersourcecommons.org.


* for each new pattern which should be published a new issue should be created
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was my understanding that we will publish the patterns on the wiki, once they are accepted in the patterns repo. Does this work with PRs, as well, @HaRo87 ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean by:

Does this work with PRs, as well, @HaRo87 ?

I think a wiki is not the right place to publish patterns, or? In a wiki you can also edit and change stuff. On the GitHub pages site of InnerSource Commons a published pattern will have a stable (not so easy to change) state.

Copy link
Contributor

@gruetter gruetter Nov 22, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this work with PRs, as well, @HaRo87 ?

I was wondering whether it is possible to restrict wiki editing with PRs. I guess we can just as well store patterns as .md files and link to them from the wiki. I personally think a 2nd PR after the first would be a bit over the top ;)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I think we have a communication issue here. ;-) I would use the GitHub pages site: innersourcecommons.org to publish the patterns, not the wiki.

* the issue should contain the name of the pattern and a link to it inside of
the InnerSourcePatterns repository
* every publishing process of a pattern idea, donut or draft should start on a
dedicated branch, originating from `master` starting with
`feature/[issue-number]---[title]`