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
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>
Copy file name to clipboardExpand all lines: patterns/2-structured/trusted-committer.md
+37-38Lines changed: 37 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,51 +6,49 @@ Trusted Committer
6
6
7
7
Many InnerSource projects will find themselves in a situation where
8
8
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
10
10
work of the contributor above and beyond single contributions.
11
11
12
12
## Problem
13
13
14
14
- Project maintainers want to find ways to scale their ability to support a project
15
15
- Project maintainers want to find ways to lengthen the value delivered by a project
16
16
- 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
18
18
19
19
## Context
20
20
21
21
- You are the maintainer of a cross-team library, service, or shared resource
22
22
- You receive regular contributions
23
+
- You receive regular feature requests
24
+
- You receive regular bug-fix requests
23
25
- There are motivated contributors looking to build expertise through InnerSource projects
24
26
25
27
## Forces
26
28
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
29
31
- Maintaining a project of reasonable complexity is taxing for a small team
32
+
- Developing project features at scale is taxing for a small team
30
33
31
34
## Solution
32
35
33
36
### Defining the Trusted Committer Role for a Project
34
37
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.
39
39
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:
42
41
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.
45
44
46
45
### Formalizing Trusted Committers
47
46
48
47
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.
52
50
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
54
52
publicly recognize the transition from user to Trusted Committer. It is also a
55
53
good idea to add their name to a Trusted Committers section in your project's
56
54
README. As an example:
@@ -75,50 +73,49 @@ README. As an example:
75
73
76
74
### Maintaining Trusted Committer Relationships
77
75
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
81
79
planning sessions. More opportunities for involvement gives Trusted Committers
82
80
a path to Maintainer if they so desire.
83
81
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.
92
89
93
90
### Sunsetting a Trusted Committer
94
91
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:
97
94
98
95
* No longer willing to take part
99
96
* No longer able to perform their duties
100
97
* No longer employed by the company
101
98
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.
105
102
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.
109
106
110
107
## Resulting Context
111
108
112
109
### For Contributors
113
110
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
116
113
efforts can be used during annual reviews with managers.
117
114
118
115
### For Maintainers
119
116
120
117
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
122
119
aspects of the project are better served over time.
123
120
124
121
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:
0 commit comments