|
| 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 | +All regular events mentioned in this chapter are tracked in the [calendar repository]. |
| 11 | +The calendar file is also available for download: [clippy.ics] |
| 12 | + |
| 13 | +## Everyone |
| 14 | + |
| 15 | +Everyone, including you, is welcome to join discussions and contribute in other |
| 16 | +ways, like PRs. |
| 17 | + |
| 18 | +You also have some triage rights, using `@rustbot` to add labels and claim |
| 19 | +issues. See [labeling with @rustbot]. |
| 20 | + |
| 21 | +A rule for everyone should be to keep a healthy work-life balance. Take a break |
| 22 | +when you need one. |
| 23 | + |
| 24 | +## Clippy-Contributors |
| 25 | + |
| 26 | +This is a group of regular contributors to Clippy to help with triaging. |
| 27 | + |
| 28 | +### Duties |
| 29 | + |
| 30 | +This team exists to make contributing easier for regular members. It doesn't |
| 31 | +carry any duties that need to be done. However, we want to encourage members of |
| 32 | +this group to help with triaging, which can include: |
| 33 | + |
| 34 | +1. **Labeling issues** |
| 35 | + |
| 36 | + For the `good-first-issue` label, it can still be good to use `@rustbot` to |
| 37 | + subscribe to the issue and help interested parties, if they post questions |
| 38 | + in the comments. |
| 39 | + |
| 40 | +2. **Closing duplicate or resolved issues** |
| 41 | + |
| 42 | + When you manually close an issue, it's often a good idea, to add a short |
| 43 | + comment explaining the reason. |
| 44 | + |
| 45 | +3. **Ping people after two weeks of inactivity** |
| 46 | + |
| 47 | + We try to keep issue assignments and PRs fairly up-to-date. After two weeks, |
| 48 | + it can be good to send a friendly ping to the delaying party. |
| 49 | + |
| 50 | + You might close a PR with the `I-inactive-closed` label if the author is |
| 51 | + busy or wants to abandon it. If the reviewer is busy, the PR can be |
| 52 | + reassigned to someone else. |
| 53 | + |
| 54 | + Checkout: https://triage.rust-lang.org/triage/rust-lang/rust-clippy to |
| 55 | + monitor PRs. |
| 56 | + |
| 57 | +While not part of their duties, contributors are encouraged to review PRs |
| 58 | +and help on Zulip. The team always appreciates help! |
| 59 | + |
| 60 | +### Membership |
| 61 | + |
| 62 | +If you have been contributing to Clippy for some time, we'll probably ask you if |
| 63 | +you want to join this team. Members of this team are also welcome to suggest |
| 64 | +people who they think would make a great addition to this group. |
| 65 | + |
| 66 | +For this group, there is no direct onboarding process. You're welcome to just |
| 67 | +continue what you've been doing. If you like, you can ask for someone to mentor |
| 68 | +you, either in the Clippy stream on Zulip or privately via a PM. |
| 69 | + |
| 70 | +If you have been inactive in Clippy for over three months, we'll probably move |
| 71 | +you to the alumni group. You're always welcome to come back. |
| 72 | + |
| 73 | +## The Clippy Team |
| 74 | + |
| 75 | +[The Clippy team](https://www.rust-lang.org/governance/teams/dev-tools#Clippy%20team) |
| 76 | +is responsible for maintaining Clippy. |
| 77 | + |
| 78 | +### Duties |
| 79 | + |
| 80 | +1. **Respond to PRs in a timely manner** |
| 81 | + |
| 82 | + It's totally fine, if you don't have the time for reviews right now. |
| 83 | + You can reassign the PR to a random member by commenting `r? clippy`. |
| 84 | + |
| 85 | +2. **Take a break when you need one** |
| 86 | + |
| 87 | + You are valuable! Clippy wouldn't be what it is without you. So take a break |
| 88 | + early and recharge some energy when you need to. |
| 89 | + |
| 90 | +3. **Be responsive on Zulip** |
| 91 | + |
| 92 | + This means in a reasonable time frame, so responding within one or two days |
| 93 | + is totally fine. |
| 94 | + |
| 95 | + It's also good, if you answer threads on Zulip and take part in our Clippy |
| 96 | + meetings, every two weeks. The meeting dates are tracked in the [calendar repository]. |
| 97 | + |
| 98 | + |
| 99 | +4. **Sync Clippy with the rust-lang/rust repo** |
| 100 | + |
| 101 | + This is done every two weeks, usually by @flip1995. |
| 102 | + |
| 103 | +5. **Update the changelog** |
| 104 | + |
| 105 | + This needs to be done for every release, every six weeks. This is usually |
| 106 | + done by @xFrednet. |
| 107 | + |
| 108 | +### Membership |
| 109 | + |
| 110 | +If you have been active for some time, we'll probably reach out and ask |
| 111 | +if you want to help with reviews and eventually join the Clippy team. |
| 112 | + |
| 113 | +During the onboarding process, you'll be assigned pull requests to review. |
| 114 | +You'll also have an active team member as a mentor who'll stay in contact via |
| 115 | +Zulip DMs to provide advice and feedback. If you have questions, you're always |
| 116 | +welcome to ask, that is the best way to learn. Once you're done with the review, |
| 117 | +you can ping your mentor for a full review and to r+ the PR in both of your names. |
| 118 | + |
| 119 | +When your mentor is confident that you can handle reviews on your own, they'll |
| 120 | +start an informal vote among the active team members to officially add you to |
| 121 | +the team. This vote is usually accepted unanimously. Then you'll be added to |
| 122 | +the team once you've confirmed that you're still interested in joining. The |
| 123 | +onboarding phase typically takes a couple of weeks to a few months. |
| 124 | + |
| 125 | +If you have been inactive in Clippy for over three months, we'll probably move |
| 126 | +you to the alumni group. You're always welcome to come back. |
| 127 | + |
| 128 | +[calendar repository]: https://github.com/rust-lang/calendar/blob/main/clippy.toml |
| 129 | +[clippy.ics]: https://rust-lang.github.io/calendar/clippy.ics |
| 130 | +[labeling with @rustbot]: https://forge.rust-lang.org/triagebot/labeling.html |
0 commit comments