Skip to content

Commit 4cbe42e

Browse files
committed
RFC: Document Clippy's teams and team duties
I want to be clear: this is just the initial draft outlining what, I think, should be the responsibilities of the team members. It has not yet been discussed with anyone else.
1 parent e485a02 commit 4cbe42e

File tree

2 files changed

+113
-0
lines changed

2 files changed

+113
-0
lines changed

book/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,4 @@
3232
- [Proposals](development/proposals/README.md)
3333
- [Roadmap 2021](development/proposals/roadmap-2021.md)
3434
- [Syntax Tree Patterns](development/proposals/syntax-tree-patterns.md)
35+
- [The Team](development/the_team.md)

book/src/development/the_team.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# The team
2+
3+
Everyone who contributes to Clippy makes the project what it is. Collaboration
4+
and discussions are the lifeblood of every open-source project. Clippy has a
5+
very flat hierarchy. The teams mainly have additional access rights to the repo.
6+
7+
This document outlines the onboarding process, as well as duties, and access
8+
rights for members of a group.
9+
10+
## Everyone
11+
12+
Everyone, including you, is welcome to join discussions and contribute in other
13+
ways, like PRs.
14+
15+
You also have some triage rights, using `@rustbot` to add labels and claim
16+
issues. See
17+
[labeling with @rustbot](https://forge.rust-lang.org/triagebot/labeling.html)
18+
19+
A rule for everyone should be to keep a healthy work-life balance. Take a break
20+
when you need one.
21+
22+
## Clippy-Contributors
23+
24+
This is a group of regular contributors to Clippy to help with triaging.
25+
26+
### Duties
27+
28+
This team exists to make contributing easier for regular members. It doesn't
29+
carry any duties that need to be done. However, we want to encourage members of
30+
this group to help with triaging, which can include:
31+
32+
1. **Labeling issues**
33+
34+
For the `good-first-issue` label, it can still be good to use `@rustbot` to
35+
subscribe to the issue and help interested parties, if they post questions
36+
in the comments.
37+
38+
2. **Closing duplicate or resolved issues**
39+
40+
When you manually close and issue, it's often a good idea, to add a short
41+
comment explaining the reason.
42+
43+
3. **Ping people after two weeks of inactivity**
44+
45+
We try to keep issue assignments and PRs fairly up-to-date. After two weeks,
46+
it can be good to send a friendly ping to the delaying party.
47+
48+
You might close a PR with the `I-inactive-closed` label if the author is
49+
busy or wants to abandon it. If the reviewer is busy, the PR can be
50+
reassigned to someone else.
51+
52+
Checkout: https://triage.rust-lang.org/triage/rust-lang/rust-clippy to
53+
monitor PRs.
54+
55+
### Membership
56+
57+
If you have been contributing to Clippy for some time, we'll probably ask you if
58+
you want to join this team. Members of this team are also welcome to suggest
59+
people who they think would make a great addition to this group.
60+
61+
For this group, there is no direct onboarding process. You're welcome to just
62+
continue what you've been doing. If you like, you can ask for someone to mentor
63+
you, either in the Clippy stream on Zulip or privately via a PM.
64+
65+
If you have been inactive in Clippy for over three months, we'll probably move
66+
you to the alumni group. You're always welcome to come back.
67+
68+
## The Clippy Team
69+
70+
[The Clippy team](https://www.rust-lang.org/governance/teams/dev-tools#Clippy%20team)
71+
is responsible for maintaining Clippy.
72+
73+
### Duties
74+
75+
1. **Respond to PRs in a timely manner**
76+
77+
It's totally fine, if you don't have the time for reviews right now.
78+
You can reassign the PR to a random member by commenting `r? clippy`.
79+
80+
2. **Take a break when you need one.**
81+
82+
You are valuable! Clippy wouldn't be what it is without you. So take a break
83+
early and recharge some energy when you need to.
84+
85+
3. **Sync Clippy with the rust-lang/rust repo**
86+
87+
This should be done roughly every two weeks. This is usually done by our
88+
king @flip1995.
89+
90+
4. **Update the changelog**
91+
92+
This needs to be done for every release, every six weeks. This is usually
93+
done by @xFrednet.
94+
95+
### Membership
96+
97+
If you have been in the *Clippy-Contributors* team for some time, we'll probably
98+
reach out and ask if you want to help with reviews and eventually join the
99+
Clippy team.
100+
101+
During the onboarding process, you'll have an active Clippy team member as a
102+
mentor, who assigns PRs to you. They will shadow your reviews, meaning that
103+
they'll keep an eye on your PRs, help you with any questions, and once you're
104+
done, perform a full review. When everything looks good, they'll r+ the PR in
105+
the name of both of you.
106+
107+
When you've done several reviews and seem confident in the role, you'll be
108+
invited to join the team officially, as long as you're still interested. This
109+
onboarding phase typically takes a couple of weeks to a few months.
110+
111+
If you have been inactive in Clippy for over three months, we'll probably move
112+
you to the alumni group. You're always welcome to come back.

0 commit comments

Comments
 (0)