New Maintainers Checklist¶
Onboarding Email¶
This guide is to help onboard new maintainers into the buildtest project. To get started send an invitation email as follows:
We are pleased to invite you to the buildtest project and become a
buildtesters (a.k.a buildtest maintainer). We understand your time is
valuable; therefore we request a minimal effort of 2-3hrs per week towards buildtest.
As a buildtesters, you will be working on the following:
* Monitor and triage issues
* Assist user in slack channel (#general)
* Update documentation
* Review or triage Pull Request
* Issue new pull request
* Troubleshoot build errors in regression test or CI checks
As a buildtesters you may be granted elevated privilege to the following
services: GitHub, ReadTheDocs, Slack, and Google Analytics. As a
buildtesters, you agree to be accessible on Slack as our primary communication
channel.
If you agree to these terms, you will be assigned to work with another buildtest
maintainer in your first two weeks. Once you are confident in your duties, we
will let you work independently at your own pace, should you need help please
contact one of the buildtesters.
Please review the contributing guide: https://buildtest.readthedocs.io/en/devel/contributing.html
if you are unsure about your responsibilities as a buildtesters.
If you agree to these terms and conditions, please reply "I CONFIRM".
Thanks,
buildtest
Onboarding Checklist¶
Please make sure the maintainer has a GitHub account if not please create an account at https://github.com/join.
Ensure user has setup two-factor authentication (2FA) with GitHub.
Invite member to buildtesters organization.
Add member to buildtest repository with Role: Maintain.
Invite member to join slack channel and preferably install Slack on your workstation and phone. Please follow instructions to download slack for Windows, Mac, or Android. Slack is available on Apple Store and Google Play Store.
Once member is added to Slack, ensure member has the appropriate account type. Generally you will want member to be a Workspace Admin for more details see Slack Roles & Permissions.
Ensure member has an account at ReadTheDocs if not please request member to create an account at https://readthedocs.org/accounts/signup/. Once member has an account please add member to buildtest readthedocs project at https://readthedocs.org/dashboard/buildtest/users/. This will ensure user has ability to access readthedocs platform when troubleshooting build errors related to documentation.