Skip to content

Onboarding Checklist at Recap Time Squad

Adopted from Homebrew's new maintainer checklist

Existing squad members and leadership team uses this guide to invite and onboard new maintainers and project leaders. The community are welcome to have a look here but there's nothing you should have know.

Use the table of contents on the right side of the page (or from the navigation menu in mobile view)

Open-source maintainer

There's someone who has been making consistently high-quality contributions to Recap Time Squad and shown themselves able to make slightly more advanced contributions than just e.g. bug fixes and docs? Let's invite them to be a community maintainer!

Replace placeholders with real values

The template below is customizable, so fellow maintainers/squad members should edit it as needed.

The Recap Time Squad members and I really appreciate your help on issues, pull requests and
your contributions to $PROJECT_NAME.

We would like to invite you to have commit access and be a community maintainer.
If you agree to be a maintainer, you should spend a significant proportion of
the time you are working on Homebrew applying and self-merging widely used
changes (e.g. version updates), triaging, fixing and debugging user-reported
issues, or reviewing user pull requests. You should also be making contributions
to $PROJECT_NAME at least once per quarter.

You should watch or regularly check <project-name-repo-urls> [and/or <add more here>].
Let us know which so we can grant you commit access appropriately.

If you're no longer able to perform all of these tasks, please continue to
contribute to $PROJECT_NAME, but we will ask you to step down as a maintainer.

A few requests:

- Please make pull requests for any changes in the $PROJECT_NAME repositories (instead
  of committing directly) and don't merge them unless you get at least one approval
  and passing tests.
- Please review the Maintainer Guidelines at https://handbook.recaptime.eu.org/go/oss-maintainer-guidelines
- Please review the team-specific guides for whichever teams you will be a part of.
  Here are links to these guides:
    - Link to maintainer guides specific to project
- Continue to create branches on your fork rather than in the main repository.
  Note GitHub/GitLab's UI will create edits and reverts on the main repository if you
  make edits or click "Revert" on the Homebrew/brew repository rather than your
  own fork.
- If still in doubt please ask for help and we'll help you out.
- Please read:
    - handbook.recaptime.eu.org/go/oss-maintainer-guidelines
    - the team-specific guides linked above and in the maintainer guidelines
    - anything else you haven't read on $PROJECT_DOCS and https://handbook.recaptime.eu.org

How does that sound?

Thanks for all your work so far!

If they accept, follow a few steps to get them set up:

Squad members in general

Being part of @recaptime-dev/squad is way more involved than just maintaining open-source projects, depending on where department they fall. In this case, an issue trakcer is involved to help track the onboarding process.1

Ask them where department they want to join and select one below to see team-specific onboarding.

By default, they're officially do have maintainer access via @recaptime-dev/squad GitHub team (and its corresponding GitLab subgroup)

If they are interested in doing ops and infra, onboard them to either teams or both within the Engineering and Open-source department:

TBD

If they're interested in doing legal work and human resources, onboard them to Legal and HR Department.

For recordkeeping of finanicals and managing our Open Collective org,

Leadership team

  1. Learn how to use it in the usage docs here. ↩