Skip to content
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

Improve the onboarding access checklist for contributors, maintainers and administrators #2656

Merged
merged 10 commits into from
Sep 4, 2023
24 changes: 21 additions & 3 deletions doc/maintenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,30 @@ instead.

## Onboarding Access Checklist

seisman marked this conversation as resolved.
Show resolved Hide resolved
- Added to [python-maintainers](https://github.com/orgs/GenericMappingTools/teams/python-maintainers) team in the [GenericMappingTools](https://github.com/orgs/GenericMappingTools/teams/) organization on GitHub (gives 'maintain' permissions)
Note that anyone can contribute to PyGMT, even without being added to the
[GenericMappingTools team](https://github.com/orgs/GenericMappingTools/teams).
The onboarding items below are for people who would like to make regular
contributions, and could benefit from extra permissions to the developer and
communication tools we use.
### As a Contributor
seisman marked this conversation as resolved.
Show resolved Hide resolved

seisman marked this conversation as resolved.
Show resolved Hide resolved
- Added to the [pygmt-contributors team](https://github.com/orgs/GenericMappingTools/teams/pygmt-contributors) (gives 'write' permission to the repository)
- Added as collaborator on [DAGsHub](https://dagshub.com/GenericMappingTools/pygmt/settings/collaboration) (gives 'write' permission to dvc remote storage)
- Added as moderator on [GMT forum](https://forum.generic-mapping-tools.org) (to see mod-only discussions)
- Added as member on the [PyGMT devs Slack channel](https://pygmtdevs.slack.com) (for casual conversations)
- Added as member on [HackMD](https://hackmd.io/@pygmt) (for draft announcements) [optional]

### As a Maintainer

- Added to the [pygmt-maintainers team](https://github.com/orgs/GenericMappingTools/teams/pygmt-maintainers) (gives 'maintain' permission to the repository)
- Update the role on the {doc}`Team Gallery page <team>`
- Added as moderator on the [GMT forum](https://forum.generic-mapping-tools.org) (to see mod-only discussions) [optional]
seisman marked this conversation as resolved.
Show resolved Hide resolved
- Added as a maintainer on [Readthedocs](https://readthedocs.org/projects/pygmt-dev) [optional]

### As an Administrator

seisman marked this conversation as resolved.
Show resolved Hide resolved
- Added to the [pygmt-admin team](https://github.com/orgs/GenericMappingTools/teams/pygmt-admin) (gives 'admin' permission to the repository)
- Added as admin on [DAGsHub](https://www.dagshub.com/GenericMappingTools/pygmt/settings/collaboration)
- Added as maintainer on [PyPI](https://pypi.org/project/pygmt/) and [Test PyPI](https://test.pypi.org/project/pygmt) [optional]
seisman marked this conversation as resolved.
Show resolved Hide resolved
- Added as member on [HackMD](https://hackmd.io/@pygmt) [optional]

## Branches

Expand Down