Skip to content

Commit df5861e

Browse files
committed
Increase all header levels by one.
1 parent 7311cdc commit df5861e

36 files changed

+260
-260
lines changed

contributor/01-introduction-article.asciidoc

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
= Introduction
1+
== Introduction
22

3-
== The Contributor in InnerSource
3+
=== The Contributor in InnerSource
44

55
Have you ever been blocked in your next coding task because another team didn't have time to add a feature in their system that you depend on?
66
Perhaps after a while you even had to do some extra work in your project to work around the missing feature.
@@ -14,15 +14,15 @@ This person may or may not be part or see themselves as part of the community.
1414
However, for quite a few people there is a sort of journey that contributors can make from just knowing about the community to using the community's product to interacting with members of the community and finally starting to contribute.
1515
Finally, some of them may become https://github.com/InnerSourceCommons/InnerSourceLearningPath/blob/master/trusted-committer/01-introduction.md[Trusted Committers].
1616

17-
== Relationship to other roles
17+
=== Relationship to other roles
1818

1919
As a Contributor in an InnerSource community you will interact with people playing other roles of InnerSource, such as https://github.com/InnerSourceCommons/InnerSourceLearningPath/blob/master/trusted-committer/01-introduction.md[_Trusted Committer_] or https://github.com/InnerSourceCommons/InnerSourceLearningPath/blob/master/product-owner/01-opening-article.md[_Product Owner_] and possibly with other contributors.
2020
At times, these roles can be played by the same person, such as Trusted Committer and Product Owner in small grassroots style projects.
2121

2222
This section gives you a very short overview of the other two roles, but we'd like to encourage you to read the https://github.com/InnerSourceCommons/InnerSourceLearningPath/blob/master/trusted-committer/01-introduction.md[introductory article of the Trusted Committer role], and we recommended you read the https://github.com/InnerSourceCommons/InnerSourceLearningPath/blob/master/trusted-committer/05-lowering-the-barriers-to-entry.md[Lowering the barriers to entry] article, too, before you delve deeper into the details of the Contributor role in this section.
2323
You can also watch the videos (https://learning.oreilly.com/videos/the-trusted-committer/9781492047599/9781492047599-video323925[introduction], https://learning.oreilly.com/videos/the-trusted-committer/9781492047599/9781492047599-video323929[lowering the barriers to entry]) instead of reading the articles.
2424

25-
=== Trusted Committer
25+
==== Trusted Committer
2626

2727
A Trusted Committer will be your host for your stay in the hosting community.
2828
They are the gatekeepers to the project's code repository, and will move your contribution closer to production once they accepted it.
@@ -31,7 +31,7 @@ It is their role to mentor you on your way to contributing to their community. T
3131
They also need to care about product quality, sustainability and project evolution from technical as well as general perspective, about reducing the barrier to making contributions for everyone, as well as about caring for their community in general.
3232
Caring for the community involves keeping it healthy, upleveling it and its participants, and advocating its needs in their organization.
3333

34-
=== Product Owner
34+
==== Product Owner
3535

3636
The role of the https://github.com/InnerSourceCommons/InnerSourceLearningPath/blob/master/product-owner/01-opening-article.md[_Product Owner_] has some similarity with the product owner role of your average project.
3737
However, there are differences - depending on the size of the project, this role is often filled by the same person that acts as trusted committer.
@@ -44,7 +44,7 @@ Last but not least, someone acting as product owner might have been involved in
4444

4545
If you want to learn in more detail what these other roles are about, and we encourage you to do so, we've prepared separate sections about the https://github.com/InnerSourceCommons/InnerSourceLearningPath/blob/master/trusted-committer/01-introduction.md[_Trusted Committer_] and the https://github.com/InnerSourceCommons/InnerSourceLearningPath/blob/master/product-owner/01-opening-article.md[_Product Owner_].
4646

47-
== Section overview
47+
=== Section overview
4848

4949
In the following 5 segments you will learn more in detail about the various aspects introduced here.
5050

contributor/01-introduction-script.asciidoc

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
#Script: The Contributor in InnerSource - Introduction
22

3-
== Duration: 1-3 Mintes
3+
=== Duration: 1-3 Mintes
44

5-
== Actors: Isabel and Johannes
5+
=== Actors: Isabel and Johannes
66

7-
== Playbook Summary
7+
=== Playbook Summary
88

99
How do I best contribute to an InnerSource project? This segement shares a summary of what it means to be an InnerSource Contributor. We'll also give an overview of the upcoming training segements on being a great InnerSource Contributor.
1010

11-
== General notes
11+
=== General notes
1212

1313
J: I took quite a bit of text from the article, since I think there are nice consise parts there.
1414
However I do think that there's lots of opportunity to narrow it down, comparing it to the 1 minute text size that the intro of the intro video had.
1515
Thus, this is a work draft to have something to start with and discuss.
1616

17-
== Script
17+
=== Script
1818

19-
=== Intro
19+
==== Intro
2020

2121
I:
2222

2323
J: My name is Johannes Tigges. I am a Principal Engineer at 7Learnings, worked on introducing InnerSource to HERE Technologies and have acted as Contributor and Trusted Commiter in a number of projects within companies and the OpenSource domain.
2424

25-
=== Overview
25+
==== Overview
2626

2727
[EDITOR NOTE J: I think the article text is nice here - shortening some of it though given the 1-3 minutes timeframe.]
2828

@@ -34,7 +34,7 @@ I: With projects that incorporate InnerSource principles, you'll never be blocke
3434
J: The Contributor role describes a person that makes contributions to the repos of an InnerSource community project.
3535
This person may or may not be part or see themselves as part of the community although this often changes with continuing involvement with the community.
3636

37-
=== Relationship to other roles
37+
==== Relationship to other roles
3838

3939
\-> Possibly slide with the other two role names?
4040

@@ -56,7 +56,7 @@ J: We would like to encourage you to watch the video introducing the Trusted Com
5656

5757
\-> Possibly hinting to some links popping up with the video links ~ YouTube style or just a short link overlay?
5858

59-
=== Section overview
59+
==== Section overview
6060

6161
\-> Possbly slide with the segment names, popping up one after another?
6262

@@ -77,6 +77,6 @@ J: After we've dealt with the personal, the interaction-focused, and the technic
7777

7878
I: The last segment will recap what we've learned about being an InnerSource contributor. We'll share how you can continue your learning on InnerSource both with other online videos and involvement with the online InnerSource community.
7979

80-
=== Wish people an enjoyable time
80+
==== Wish people an enjoyable time
8181

8282
J: We wish you an enjoyable time watching the following videos and hope you can take away new insights that are valuable to you.

contributor/02-becoming-a-contributor-article.asciidoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
= Becoming an InnerSource Contributor
1+
== Becoming an InnerSource Contributor
22

33
InnerSource contributors operate outside of regular team boundaries, they are the links crossing organisational silos. As such, they need to be aware of a few common practices that make this work more effective.
44

5-
== Sharing Mindset
5+
=== Sharing Mindset
66

77
So - you're implementing a new feature for your team's product. You need some functionality to get this feature working. Instead of jumping right into the implementation, slow down for a bit: does this functionality reflect a general issue? Is it something that other teams in your organisation face as well due to the shared business domain? Is this functionality orthogonal to the domain of your project? If any of that applies, then start looking beyond your own team: is there a shared solution that you can use or improve to fit your needs? Should there be one?
88

9-
== Benefits to sharing solutions
9+
=== Benefits to sharing solutions
1010

1111
There is an African proverb stating that "`If you want to go fast, go alone. If you want to go far, go together.`" The same is true for software development teams:
1212

@@ -26,13 +26,13 @@ This way of working requires a change in mindset for many: instead of waiting fo
2626

2727
A good Contributor can comfortably make a call for when it makes both technical and business sense to introduce a dependency and reuse a component instead of duplicating work. They can talk to management to explain the benefits of InnerSource contributions.
2828

29-
== Scope of InnerSource contributions
29+
=== Scope of InnerSource contributions
3030

3131
So is Inner__Source__ only about __Source__Code? Of course not. If your team's business depends on an outside component, you want to make sure it's well maintained and well run. As an InnerSource Contributor, you can help the host team in multiple ways. Reporting issues you see when using the component is a valuable contribution. Creating or fixing test cases that show that the code isn't working as expected is valuable. So is improving documentation, so others spend less time using it and contributing to it. Supporting other users, helping with bug triage can be valuable contributions. Improving builds is another example of a valuable contribution.
3232

3333
To summarize no contribution is too small to contribute. Here is one that I made
3434
to https://github.com/tensorflow/models/pull/4784[tensorflow/models]. A simple label change in a graph.
3535

36-
== Summary of this article
36+
=== Summary of this article
3737

3838
In this article you learned about what it takes to become a Contributor. We looked at the sharing mindset. We took a deep dive into the benefits of sharing solutions. Finally we had a look at what the scope for InnerSource contributions typically looks like.

contributor/02-becoming-a-contributor-script.asciidoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
#Script: The Contributor in InnerSource - Becoming an InnerSource Contributor
22

3-
== Duration: 3-5 Mintes
3+
=== Duration: 3-5 Mintes
44

5-
== Actors: Isabel and Johannes
5+
=== Actors: Isabel and Johannes
66

7-
== Playbook Summary
7+
=== Playbook Summary
88

99
How do some people seem to find opportunity to contribute to projects everywhere? This segment describes the mindset and habits that create opportunities to become an InnerSource Contributor.
1010

11-
== Script
11+
=== Script
1212

1313
I: Welcome back to our video series on the contributor role in InnerSource. In
1414
this episode you are going to learn more on what it takes to become a successful

contributor/03-contributor-ethos-article.asciidoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Contributor Ethos
1+
== Contributor Ethos
22

33
In the last segment we have outlined why you would want to reuse components and
44
become active as a Contributor. This artice is sharing best practices on how to
@@ -14,7 +14,7 @@ behave in a certain way:
1414
1515
How do these expectations apply to InnerSource projects?
1616

17-
== Getting in
17+
=== Getting in
1818

1919
When visiting your neighbors, you will likely not enter their home without
2020
knocking or ringing the door bell even if the door is open. Likewise in InnerSource
@@ -83,7 +83,7 @@ on your submission. This can
8383
alleviate the host team's fear of the contributors not being available for
8484
support with fixing bugs after the time on contribution.
8585

86-
== Anticipate and follow house rules
86+
=== Anticipate and follow house rules
8787

8888
When visiting your neighbors, they will likely help you around in their
8989
apartment: they'll show you the way to their living room and where the restroom
@@ -116,7 +116,7 @@ archived and searchable. The benefit here is with others coming after you with
116116
similar proposals: instead of walking the exact same path again, they can learn
117117
what was discussed before and start from there.
118118

119-
== Understand they are not the home owner and act accordingly.
119+
=== Understand they are not the home owner and act accordingly.
120120

121121
Being a Contributor essentially means being somehow closer to the host team than
122122
someone merely requesting a feature. Still Contributors are not accountable for

contributor/03-contributor-ethos-script.asciidoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
#Script: The Contributor in InnerSource - Contributor Ethos
22

3-
== Duration: 5-6 Mintes
3+
=== Duration: 5-6 Mintes
44

5-
== Actors: Isabel and Johannes
5+
=== Actors: Isabel and Johannes
66

7-
== Playbook Summary
7+
=== Playbook Summary
88

99
A Contributor to an InnerSource project is like a guest in a home. How should a Contributor behave in order to have a pleasant visit and also to receive a return invitation? This segment describes how to be a good Contributor in terms of this guest-in-home analogy.
1010

11-
== Script
11+
=== Script
1212

1313
I: In the previous video section we took a closer look at when to become an
1414
InnerSource contributor. We also investigated which types of contributions

contributor/04-mechanics-of-contributing-article.asciidoc

+14-14
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Mechanics of contributing
1+
== Mechanics of contributing
22

33
Are you ready to start contributing to other teams projects/repos?
44
Do you look forward to reducing your blockers not by management escalation but by collaboration?
@@ -13,9 +13,9 @@ This article is separated into the three steps you will likely experience
1313
If your contribution is larger, you'll possibly go through (some) of these steps repeatedly as you iterate towards your common goal.
1414
It is very likely that, as you do this, everything will feel more and more natural - maybe you'll even wonder why you were doing anything else before.
1515

16-
== Preparing to work
16+
=== Preparing to work
1717

18-
=== Lead times
18+
==== Lead times
1919

2020
One key difference is the turnaround time.
2121
With every first time contribution you are coming to a new (host) team.
@@ -31,7 +31,7 @@ It's better to add more slack time initially - you'll get a feeling about the tu
3131
Often, you will notice a reduction in turnaround time per host team after making a few successful contributions to that host team.
3232
This effect can be observed with Open Source as well, you can read more about it <<buildup-of-trust-through-collaboration,here>>.
3333

34-
=== Expectation management
34+
==== Expectation management
3535

3636
In your classic teams everyone had an idea of the expected lead times.
3737
Within an InnerSource context this might not be the case, either due to large time-zone differences (e.g. Seattle, USA with PDT vs Berlin, Germany with CEST) or you not being available full-time as with your original team, even if they are in the same physical location as you are.
@@ -41,7 +41,7 @@ Ideally, you can provide them with a rough estimate when you will likely have ti
4141
Doing so builds trust by reliability even over non-physical contact, longer distance or otherwise asynchronous media.
4242
Established trust will allow you to overcome uncertainty bumps in the collaborative road ahead of you.
4343

44-
=== Building trust
44+
==== Building trust
4545

4646
InnerSource puts huge weight on written communication - in particular when it comes to project decisions.
4747
Does that imply that in-person communication is forbidden?
@@ -50,7 +50,7 @@ Clearly not: while written communication shines when it comes to archiving and s
5050
Try to make time to meet with people behind the names. If possible, try to meet them over your favorite beverage or some food.
5151
When you're able to hear people speak, when you know their idiosyncrasies, remote collaboration will become easier.
5252

53-
=== Avoiding rejection
53+
==== Avoiding rejection
5454

5555
Do you have a large feature that you want to contribute?
5656
Excellent!
@@ -67,9 +67,9 @@ Ideally, choose the way where artifacts are public, searchable and perma-linkabl
6767

6868
This type of high-level, early upfront agreement will save time in rework or rejection of your pull request down the road.
6969

70-
== Creating the pull request
70+
=== Creating the pull request
7171

72-
=== Communication and unblocking yourself
72+
==== Communication and unblocking yourself
7373

7474
Great, you've made yourself familiar with the host team's approach and they are looking forward to receive your pull request.
7575
Which gotchas are there waiting for you now?
@@ -99,21 +99,21 @@ As you work, if you find missing (or out-of-date) documentation, do a favor to t
9999
Project teams are often happy to receive additions, updates or corrections for their existing documentation - you've just found another opportunity to contribute!
100100
(Or just politely provide them with a feedback on your experience, and what would have helped you.)
101101

102-
=== Crafting the code
102+
==== Crafting the code
103103

104104
We all have our preferences and opinions on code style, indentation, etc.
105105
The host team's project has them as well.
106106
Try to adapt and match those preferences even if it's not what you would normally do, and even if it is not specified in the projects' https://github.com/InnerSourceCommons/InnerSourceLearningPath/blob/master/trusted-committer/05-lowering-the-barriers-to-entry.md[_`CONTRIBUTING.md`_].
107107
If you are unsure, you can always ask politely. Nevertheless, a guest contribution for a feature or a bug fix is not the time to introduce a new way of structuring or formatting project code.
108108

109-
== Submitting the pull request
109+
=== Submitting the pull request
110110

111111
You've completed all the essential work, figured out all the quirks of the problem and the project you are contributing to, the time you've planned for the new feature to be used comes nearer, and you want to make sure your contribution gets merged in as fast and smooth as possible.
112112

113113
Here's what you can do to make reviewing and merging as easy as possible for the the https://github.com/InnerSourceCommons/InnerSourceLearningPath/blob/master/trusted-committer/01-introduction.md[_Trusted Committer_] and the host team.
114114
This might actually be pretty similar to what you may already be doing on your own project to get your changes accepted. If that's the case - great, this is going to come natural to you!
115115

116-
=== Testing and automation
116+
==== Testing and automation
117117

118118
The basic point here is to enable the https://github.com/InnerSourceCommons/InnerSourceLearningPath/blob/master/trusted-committer/01-introduction.md[_Trusted Committer_] to validate the contribution without your presence and to ensure easy maintainability.
119119
Imagine you've built a feature or handling of an unsolvable quirk, or an important performance tweak, and your code is not entirely obvious (or might even look hacky / wrong at the first glance).
@@ -129,7 +129,7 @@ To achieve this do the following:
129129
** If your pull request keeps breaking tests, and you can't find out why after giving it your best shot: try to highlight those tests in the pull request comment, illustrate your current understanding of the problem and ask for help on it.
130130
* Don't forget your own project that triggered your contribution in the first place. Create a modified build of the shared project with your changes and try it out in your own project that consumes it.
131131

132-
=== Documentation and reviewability
132+
==== Documentation and reviewability
133133

134134
You'll want to ensure that your pull request includes any documentation updates that are relevant to your changes.
135135
Should the documentation live in a different place, make sure you add them there and link to them in your pull request.
@@ -150,9 +150,9 @@ You can still bind them together with an issue that you are referring to.
150150
*** The host team's responsibility is to create an atmosphere where sharing and discussing not-totally-polished work is possible and welcome. If you can't fail safe, you can't innovate, and collaboration becomes very hard.
151151
*** Try to balance between asking for a review early and providing meaningful changes to review.
152152

153-
== Additional articles
153+
=== Additional articles
154154

155155
Some of these resources might be hidden behind paywalls.
156156
Sometimes your employer has a subscription enabling access, otherwise public university libraries often allow access for guests, too.
157157

158-
=== https://doi.org/10.1109/MS.2013.95[Buildup of trust through collaboration]
158+
==== https://doi.org/10.1109/MS.2013.95[Buildup of trust through collaboration]

0 commit comments

Comments
 (0)