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
{{ message }}
This repository was archived by the owner on Sep 1, 2022. It is now read-only.
A course about Innersource basics within an organization.
1
+
Organizations of all sizes and in all industries are chatting about innersource concepts. This course walks you through some of the key concepts of innersource and helps you build up an internal toolkit for adopting innersource practices.
2
+
3
+
After completing this course, you'll be able to:
4
+
- contrast user versus organization owned projects
5
+
- make recommendations about the number of GitHub organizations you should have
6
+
- create discoverable repositories
7
+
- create robust repository READMEs
8
+
- use issue and pull request templates
9
+
- build transparency into repositories
10
+
- measure the success of innersource within your organization
title: Discover and reuse projects within your organization
2
-
tagline: Discover and reuse projects within your organization
3
-
description: Discover and reuse projects within your organization
2
+
tagline: High level yet impactful innersource concepts to help transform your organization.
3
+
description: Organizations of all sizes and in all industries are chatting about innersource concepts. This course walks you through some of the key concepts of innersource and helps you build up an internal toolkit for adopting innersource practices.
4
4
template:
5
5
name: innersource
6
6
repo: innersource-template
7
7
before:
8
8
- type: createIssue
9
9
title: Welcome
10
-
body: welcome.md
10
+
body: 00_welcome.md
11
+
- type: updateBranchProtection
12
+
13
+
# Course artifacts:
14
+
# 1. Issue: Welcome
15
+
# 2. PR: Repository ownership and names
16
+
# 3. PR: Create discoverable repos
17
+
# 4. PR: Issue and PR templates
18
+
# 5. PR: Workflows
19
+
# 6. PR: Managing projects on GitHub
20
+
# 7. PR: Measuring success
21
+
# 8: Issue: Publish your toolkit
11
22
12
23
steps:
13
24
14
25
#1
15
26
- title: Answer your first challenge question
16
-
description: Answer your first challenge question
27
+
description: Determine the differences between open source and innersource.
17
28
link: '{{ repoUrl }}/issues/1'
18
29
event: issues.edited
19
30
actions:
20
-
- type: respond
21
-
with: innersource-v-opensource.md
22
-
- type: closeIssue
23
31
- type: createPullRequest
24
32
title: Repository ownership and names
25
33
head: repo-owner
26
-
body: repo-owner.md
34
+
body: 01_repo-owner.md
27
35
action_id: ownerPR
28
36
- type: respond
29
-
with: goto-pr.md
37
+
with: 01_innersource-v-opensource.md
30
38
data:
31
39
url: '%actions.ownerPR.data.html_url%'
40
+
- type: closeIssue
41
+
32
42
33
43
#2
34
-
- title: Answer the owner challenge
35
-
description: Answer the owner challenge
44
+
- title: Answer the ownership challenge
45
+
description: Discover how repository ownership affects visibility and access.
46
+
link: '{{ repoUrl }}/pull/2'
36
47
event: pull_request.edited
37
48
actions:
49
+
- type: removeBranchProtection
38
50
- type: respond
39
-
with: repo-owner-answer.md
51
+
with: 02_repo-owner-answer.md
40
52
41
53
#3
42
-
- title: Merge the ownership PR
43
-
description: Merge the ownership PR
54
+
- title: Merge the ownership pull request
55
+
description: Beef up your innersource toolkit with resources about repository ownership.
56
+
link: '{{ repoUrl }}/pull/2'
44
57
event: pull_request.closed
45
58
actions:
59
+
- type: updateBranchProtection
46
60
- type: createPullRequest
47
61
title: Create discoverable repos
48
62
head: discoverable-repos
49
-
body: discoverable.md
63
+
body: 03_discoverable.md
50
64
action_id: discoverablePR
51
65
- type: respond
52
66
with: goto-pr.md
@@ -55,21 +69,25 @@ steps:
55
69
56
70
#4
57
71
- title: Answer the discoverability challenge
58
-
description: Answer the discoverability challenge
72
+
description: Learn about ways to make your repository easy to discover.
73
+
link: '{{ repoUrl }}/pull/3'
59
74
event: issue_comment.created
60
75
actions:
76
+
- type: removeBranchProtection
61
77
- type: respond
62
-
with: discoverability-answer.md
78
+
with: 04_discoverability-answer.md
63
79
64
80
#5
65
-
- title: Merge the discoverability PR
66
-
description: Merge the discoverability PR
81
+
- title: Merge the discoverability pull request
82
+
description: Add resources for making discoverable repositories to your innersource toolkit.
83
+
link: '{{ repoUrl }}/pull/3'
67
84
event: pull_request.closed
68
85
actions:
86
+
- type: updateBranchProtection
69
87
- type: createPullRequest
70
88
title: Issue and PR templates
71
89
head: templates
72
-
body: templates.md
90
+
body: 05_templates.md
73
91
action_id: templatesPR
74
92
- type: respond
75
93
with: goto-pr.md
@@ -78,21 +96,25 @@ steps:
78
96
79
97
#6
80
98
- title: Answer the templates challenge question
81
-
description: Answer the templates challenge question
99
+
description: Determine how template files can help you create easy-to-join projects.
100
+
link: '{{ repoUrl }}/pull/4'
82
101
event: pull_request.edited
83
102
actions:
103
+
- type: removeBranchProtection
84
104
- type: respond
85
-
with: templates-answer.md
105
+
with: 06_templates-answer.md
86
106
87
107
#7
88
-
- title: Merge the templates PR
89
-
description: Merge the templates PR
108
+
- title: Merge the templates pull request
109
+
description: Add starter templates to your innersource toolkit.
110
+
link: '{{ repoUrl }}/pull/4'
90
111
event: pull_request.closed
91
112
actions:
113
+
- type: updateBranchProtection
92
114
- type: createPullRequest
93
115
title: Workflows
94
116
head: workflows
95
-
body: workflows.md
117
+
body: 07_workflows.md
96
118
action_id: workflowsPR
97
119
- type: respond
98
120
with: goto-pr.md
@@ -101,21 +123,25 @@ steps:
101
123
102
124
#8
103
125
- title: Answer the workflows challenge question
104
-
description: Answer the workflows challenge question
126
+
description: Discover how being transparent about your workflow can help others contribute.
127
+
link: '{{ repoUrl }}/pull/5'
105
128
event: pull_request.edited
106
129
actions:
130
+
- type: removeBranchProtection
107
131
- type: respond
108
-
with: workflows-answer.md
132
+
with: 08_workflows-answer.md
109
133
110
134
#9
111
-
- title: Project management
112
-
description: Project management
135
+
- title: Merge the workflows pull request
136
+
description: Add branching and workflow strategies to your innersource toolkit.
137
+
link: '{{ repoUrl }}/pull/5'
113
138
event: pull_request.closed
114
139
actions:
140
+
- type: updateBranchProtection
115
141
- type: createPullRequest
116
142
title: Managing projects on GitHub
117
143
head: projects
118
-
body: projects.md
144
+
body: 09_projects.md
119
145
action_id: projectsPR
120
146
- type: respond
121
147
with: goto-pr.md
@@ -124,21 +150,25 @@ steps:
124
150
125
151
#10
126
152
- title: Answer the project management challenge
127
-
description: Answer the project management challenge
153
+
description: Learn about how you can surface your project management strategies to potential contributors.
154
+
link: '{{ repoUrl }}/pull/6'
128
155
event: pull_request.edited
129
156
actions:
157
+
- type: removeBranchProtection
130
158
- type: respond
131
-
with: projects-answer.md
159
+
with: 10_projects-answer.md
132
160
133
161
#11
134
-
- title: Measuring success
135
-
description: Measuring success
162
+
- title: Merge the project management pull request
163
+
description: Beef up your innersource toolkit with project management tips.
164
+
link: '{{ repoUrl }}/pull/6'
136
165
event: pull_request.closed
137
166
actions:
167
+
- type: updateBranchProtection
138
168
- type: createPullRequest
139
169
title: Measuring success
140
170
head: metrics
141
-
body: metrics.md
171
+
body: 11_metrics.md
142
172
action_id: metricsPR
143
173
- type: respond
144
174
with: goto-pr.md
@@ -147,26 +177,42 @@ steps:
147
177
148
178
#12
149
179
- title: Answer the success metrics challenge
150
-
description: Answer the success metrics challenge
180
+
description: Begin thinking about how to measure the success of your innersource program.
181
+
link: '{{ repoUrl }}/pull/7'
151
182
event: issue_comment.created
152
183
actions:
184
+
- type: removeBranchProtection
153
185
- type: respond
154
-
with: metrics-answer.md
186
+
with: 12_metrics-answer.md
155
187
156
188
#13
157
-
- title: Merge the final PR
158
-
description: Merge the final PR
189
+
- title: Merge the metrics pull request
190
+
description: Add possible metrics to your innersource toolkit.
Copy file name to clipboardExpand all lines: responses/01_innersource-v-opensource.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
3
3
Innersource and open source are very similar concepts, but they're not the same.
4
4
5
-
**Open source** software is shared publicly and typically accepts contributions from contributors outside of an organization.
5
+
**Open source** software public and typically accepts contributions from outside of an organization.
6
6
7
-
**Innersource** is the practice of adopting open source practices internally within your organization. An organization that practices innersource, may or may not end up open sourced.
7
+
**Innersource** is the practice of adopting open source practices internally within your organization. An organization that practices innersource, may or may not end up open sourced.
8
+
9
+
You can find your next steps in the [next pull request]({{ url }}).
Copy file name to clipboardExpand all lines: responses/02_repo-owner-answer.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,12 +7,16 @@ A repository _does_ exist at githubtraining/training-manual, but it is private.
7
7
<details>
8
8
<summary>Why can't you see it then? Review the <b>Files Changed</b> tab and see if you can figure it out. Collapse this text if you'd like an explanation.</summary>
9
9
10
-
The repository `training-manual` in the @githubtraining organization is private, and only visible to memebers of that organization. If you're not a member of the organization, it'll appear like the repository doesn't exist to you. This is an example of why having the right ownership structure is important. Having too many organizations with restrictive permissions means that each organization's work will be siloed.
10
+
The repository `training-manual` in the @githubtraining organization is private. It's only visible to members of that organization. If you're not a member of the organization, it'll appear like the repository doesn't exist to you. This is an example of why having the right ownership structure is important. Having too many organizations with restrictive permissions silos and isolates each organization's work.
11
11
</summary>
12
12
13
13
Here are some recommendations based on some :sparkles: use of GitHub that we've seen:
14
-
-aim for as few organizations as possible, remember: each organization is a black box to those outside of that organization
15
-
-name your repositories in a meaningful manner, usually a simple project or application name will suffice
14
+
-Aim for as few organizations as possible. Remember, each organization is a black box to those outside of that organization.
15
+
-Name your repositories in a meaningful manner. Usually a simple project or application name will suffice.
16
16
</summary>
17
+
</details>
17
18
18
-
Please merge this PR.
19
+
Please merge this pull request.
20
+
21
+
<hr>
22
+
<h3align="center">I'll respond when you merge this pull request.</h3>
This PR is all about how to make your repositories more discoverable.
1
+
This pull request is all about how to make your repositories more discoverable.
2
2
3
3
### Challenge question
4
4
5
5
What is this repository for?
6
6
7
7
8
8
9
-
I'll respond when I detect you've submitted a comment on this PR.
9
+
<hr>
10
+
<h3align="center">I'll respond when I detect you comment on this pull request.</h3>
Copy file name to clipboardExpand all lines: responses/04_discoverability-answer.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,13 @@ This repository is the source code for https://services.github.com.
5
5
Did you guess it? Probably not, because it doesn't contain many of the necessary elements to make a repository discoverable.
6
6
7
7
Some suggestions to ensure your teammates can find your repository are:
8
-
-use a descriptive repository name
9
-
-give your repository a description
10
-
-provide a URL for the deployment of the app, or documentation about this project
8
+
-Use a descriptive repository name
9
+
-Give your repository a description
10
+
-Provide a URL for the deployment of the app, or documentation about this project
11
11
12
12
Discover more about how to make a repository discoverable by visiting the **Files Changed** tab. It's OK if you want to do this later, any resources we cover throughout the course will be available at the end.
13
13
14
-
Please merge this PR.
14
+
Please merge this pull request.
15
+
16
+
<hr>
17
+
<h3align="center">I'll respond when you merge this pull request.</h3>
0 commit comments