-
Notifications
You must be signed in to change notification settings - Fork 273
Create trial-maintainers.md #613
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Trial maintainers & Mentoring | ||
|
|
||
| Trial maintainers are candidates for full maintainer-ship who are under the supervision of a full maintainer, who tutors them and gives them the chance to improve their knowledge of programming and the codebase. This includes a basic introduction to our tooling, workflows, meetings, and getting accustomed to how maintainers handle everyday tasks. | ||
|
|
||
| The role is intended to enable us to recruit more people as upstream maintainers and to support the onboarding process overall. Since trial maintainers don't have as much codebase knowledge yet, we expect mistakes, and the mentoring maintainer will serve as a safety net to maintain code quality and avoid bugs in the game. | ||
|
|
||
| Our focus for trial maintainers and their mentoring is to teach and support them during their trial period. Helping them acquire a sense for healthy programming practices that would otherwise take a long time to build up on their own. | ||
|
|
||
| ## Trial maintainer application | ||
| After their application trial, maintainers will be accepted through the same vote that normal maintainers require. In addition, maintainers will look at their previous coding work listed in their application and ask the person who vouched for them about their behaviour in other communities to make sure they are a good fit for our staff. Trial maintainers can only be accepted if a maintainer volunteers as a mentor. | ||
|
|
||
| ## Peer Reviews | ||
| Mentors hold occasional peer reviews in a voice chat with their assigned trial maintainers to teach them how to spot problematic code, communicate with contributors constructively, and answer any questions that come up during the review. | ||
|
|
||
| Additionally, an introductory onboarding session will be held shortly after the applicant has been accepted. | ||
|
|
||
| ## Trial maintainer-ship duration | ||
| (The preliminary trial duration is 2 months. This may be adjusted later, after the first few trials have passed. After the trial period, the assigned mentor presents their opinion on the trial maintainer, and maintainers vote on whether the trial continues, ends, or is accepted as a full maintainer. | ||
|
|
||
| ## Limitations | ||
| - No PII access (Grafana etc.) | ||
| - No codermin in-game permissions | ||
| - An additional maintainer approval is required for merging PRs until the mentoring maintainer decides they are fit to follow the normal PR review policy. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. A bit vague? I assume this means they can approve PRs but any PRs they approve require a second maintainer approval always. Also seems like something where we'd want to wait for them to be promoted before they get full perms.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think it makes sense to always have a second maintainer review, but I do think their review should count as a "normal" review just that they can't click the merge button and they can't merge prs with only their approval 🤔
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Is this decision separate from their trialmin status?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes but we are probably going to change that specific paragraph a bit. I didn't have time to address the reviews yet. They are also normal reviews. What we meant is that if they can get the extra restrictions on merging removed during their trial |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It could be good to copy from admins and have bi-weekly checkups on their maintainer actions, especially once they get proper merge permissions.
Duration of 2 months is probably fine, but this also implies if they fail the initial 2 month vote they have to wait another 2 months which is a bit of a long wait. Could be best to leave that up to the judgement of their mentor with a minimum of 2 months.