Skip to content

Commit a2c20a1

Browse files
doronkatzspier
andauthored
Structured pattern corrections - Trusted Committer (#297)
Active voice fixes, and re-wording of complex/long sentences in the Trusted Committer pattern. Some further improvements/corrections. Co-authored-by: Sebastian Spier <github@spier.hu>
1 parent aa8325e commit a2c20a1

1 file changed

Lines changed: 37 additions & 38 deletions

File tree

patterns/2-structured/trusted-committer.md

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -6,51 +6,49 @@ Trusted Committer
66

77
Many InnerSource projects will find themselves in a situation where
88
they consistently receive feedback, features, and bug-fixes from contributors.
9-
In these situations project maintainers seek ways to recognize and reward the
9+
In these situations, project maintainers seek ways to recognize and reward the
1010
work of the contributor above and beyond single contributions.
1111

1212
## Problem
1313

1414
- Project maintainers want to find ways to scale their ability to support a project
1515
- Project maintainers want to find ways to lengthen the value delivered by a project
1616
- Project maintainers want to visibly reward frequent contributors and empower them to amplify their value contribution.
17-
- Lack of language for recognizing contributions across teams within an organization
17+
- Lack of mechanism and language for recognizing contributions across teams within an organization
1818

1919
## Context
2020

2121
- You are the maintainer of a cross-team library, service, or shared resource
2222
- You receive regular contributions
23+
- You receive regular feature requests
24+
- You receive regular bug-fix requests
2325
- There are motivated contributors looking to build expertise through InnerSource projects
2426

2527
## Forces
2628

27-
- Over the lifecycle of a project the focus of the maintainers may shift away to accommodate changing business priorities
28-
- Contributors seek visible artifacts of their contributions demonstrating value
29+
- Over the lifecycle of a project, the focus of the maintainers may shift away to accommodate changing business priorities
30+
- Contributors seek visible recognition of their contributions, demonstrating value
2931
- Maintaining a project of reasonable complexity is taxing for a small team
32+
- Developing project features at scale is taxing for a small team
3033

3134
## Solution
3235

3336
### Defining the Trusted Committer Role for a Project
3437

35-
What a Trusted Committer handles is up to each project and its maintainers.
36-
Whatever shape your Trusted Committer role takes, make sure it's clearly
37-
documented somewhere in your project. This sets expectations for new community
38-
members and outlines the role for future candidates.
38+
What a Trusted Committer handles is up to each project and its maintainers. Ensure you document within the project the scope of your Trusted Committer role. Clear documentation sets expectations for new community members and establishes the role for future candidates.
3939

40-
Below we've provided a few guidelines for what Trusted Committers can be
41-
invited to do:
40+
The following are a few guidelines for identifying a potential Trusted Committer:
4241

43-
* If a candidate participates often in community channels (e.g. Slack, JIRA issue triaging, etc.) then becoming a Trusted Committer formalizes their role in community support.
44-
* A good candidate for a Trusted Committer, is someone who frequently submits code, documentation, or other repository changes. Start by including this person on pull requests. If they are actively engaging in pull requests, consider approaching them about opportunities for further collaboration on the project.
42+
* An active participant in community channels (Slack, JIRA issue triaging, etc.) becomes a Trusted Committer, thereby formalizing their role in community support.
43+
* Someone who frequently submits code, documentation, or other repository changes. Start by including this person on pull requests. If they are actively engaging in pull requests, consider approaching them about opportunities for further collaboration on the project.
4544

4645
### Formalizing Trusted Committers
4746

4847
The first step is to approach candidates about becoming a Trusted Committer.
49-
Maintainers should make sure candidates understand the role. To be clear:
50-
there is no expectation that candidates will accept the role. Each candidate
51-
should figure out if they have the bandwidth to get involved.
48+
Maintainers should educate candidates on the role of a Trusted Committer. There is no expectation that candidates will accept the role of Trusted Committer. Each candidate
49+
should assess if they have the available bandwidth to take on the responsibilities.
5250

53-
When a candidate accepts the role it is up to the project maintainers to
51+
When a candidate accepts the role, it is up to the project maintainers to
5452
publicly recognize the transition from user to Trusted Committer. It is also a
5553
good idea to add their name to a Trusted Committers section in your project's
5654
README. As an example:
@@ -75,50 +73,49 @@ README. As an example:
7573

7674
### Maintaining Trusted Committer Relationships
7775

78-
When a new Trusted Committer is minted it’s a good idea to keep them in the
79-
loop as you continue to iterate on your project. This can be as simple as
80-
inviting them to your project channel or as involved as including them in your
76+
Once you formalize a new Trusted Committer, it is a good idea to keep them in the
77+
loop as you continue to iterate on your project. Keeping them in the loop can be as
78+
simple as inviting them to your project channel or as involved as including them in your
8179
planning sessions. More opportunities for involvement gives Trusted Committers
8280
a path to Maintainer if they so desire.
8381

84-
Besides keeping Trusted Committers informed it’s a good idea to check in on a
85-
regular basis. A good cadence is every week, but as the Trusted Committer
86-
settles in this can drop to every few weeks or so. The purpose of these
87-
check-ins is to make sure the Trusted Committer feels supported in their new
88-
role, like a 1:1 with your manager. If things aren’t going well, listen and
89-
try to understand what is preventing the Trusted Committer from being successful.
90-
If things are going well, [thank the Trusted Committer for their continued
91-
effort][praise] in making the project successful and set a new date to check-in.
82+
Besides keeping Trusted Committers informed, it is good to check in on a
83+
regular basis. A suggested cadence is to start with every week before gradually
84+
progressing to every few weeks. The purpose of these check-ins is to make sure the
85+
Trusted Committer feels supported in their new role. Analogous to a 1:1 with your
86+
manager, if there are any issues, listen and empathize to try and understand
87+
what is preventing the Trusted Committer from being successful. Always
88+
[thank the Trusted Committer for their continued effort][praise] in making the project successful and set a new date to check-in.
9289

9390
### Sunsetting a Trusted Committer
9491

95-
There comes a time when removal of a Trusted Committer is necessary, for
96-
example:
92+
There are times which necessitate removing a Trusted Committer, such as if the Trusted
93+
Committer is:
9794

9895
* No longer willing to take part
9996
* No longer able to perform their duties
10097
* No longer employed by the company
10198

102-
In each of the above cases a plan for removing access to project resources
103-
should be agreed upon by both parties. This includes transitioning their entry in
104-
a project's **Trusted Committer** section to a list of past contributors.
99+
A plan for removing access to project resources should be agreed upon by both parties,
100+
including transitioning their entry in a project's **Trusted Committer** section to a
101+
list of past contributors.
105102

106-
After access is removed it is courteous to [thank the Trusted Committer for
107-
their participation in a public way][praise]. This ensures clear communication
108-
and continuity within the community.
103+
Upon removing access, [thank the Trusted Committer for
104+
their participation publicly][praise]. Public acknowledgment ensures clear
105+
communication of transition and continuity within the community.
109106

110107
## Resulting Context
111108

112109
### For Contributors
113110

114-
Achieving Trusted Committer status for a project is a sign that the contributor
115-
has demonstrated an improvement to a community project. Recognition for these
111+
Achieving Trusted Committer status for a project demonstrates initiative in
112+
contributing to the community project. Recognition for these
116113
efforts can be used during annual reviews with managers.
117114

118115
### For Maintainers
119116

120117
As a project matures, maintainers can become less familiar with key aspects
121-
of a project. Trusted Committers fill in these gaps. This ensures that all
118+
of a project. Trusted Committers fill in these gaps, ensuring that all
122119
aspects of the project are better served over time.
123120

124121
A healthy set of Trusted Committers ensures that if project maintainers move on
@@ -146,7 +143,9 @@ This has been tried and proven successful at:
146143
- [Loren Sanz]
147144
- [Noah Cawley]
148145
- [Jeremy Hicks]
146+
- [Doron Katz]
149147

148+
[Doron Katz]: https://github.com/doronkatz
150149
[Russell Rutledge]: https://github.com/rrrutledge
151150
[Loren Sanz]: https://github.com/mrsanz
152151
[Jeremy Hicks]: https://github.com/greatestusername

0 commit comments

Comments
 (0)