Skip to content

Commit

Permalink
Merge pull request #21 from georust/mkirk/crate-publishing-teams
Browse files Browse the repository at this point in the history
Proposal: Smaller Publishing Teams on crates.io
  • Loading branch information
michaelkirk committed Oct 21, 2020
2 parents 643164d + 4c24def commit 5b4cbdb
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions GUIDELINES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Guidelines for GeoRust Projects

## What is a GeoRust project?

GeoRust is a community working to deliver high quality geospatial software
using [Rust](https://rust-lang.org), a programming language focused on
performance, reliability, and productivity.

We want to write down some of the expectations for projects within the GeoRust
organization. This document is incomplete by nature. We will work to amend it
in a way that strikes a good balance between addressing pressing concerns while
remaining clear and concise enough that we can expect people to actually read
it.

## Crate publishing teams

Members should create a dedicated team on GitHub for publishing their crate to
crates.io. It's OK if that team remains empty for now, but it serves as a way
for [organization
owners](https://github.com/orgs/georust/people?query=role%3Aowner) to recover
if the original maintainer moves on from the project or is otherwise
indisposed.

**Step 1: Create your publishing team**

Go to https://github.com/orgs/georust/new-team and enter a name like
`_my-crate_-publishers`. For example, `geojson-publishers` and use the
description `crates.io publishing`.

Add any additional publishers to the team at this point. If you make them [team
maintainers](https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-organizations-and-teams/giving-team-maintainer-permissions-to-an-organization-member),
they will be able to edit the team themselves in the future.

**Step 2: Update crate owners**

cd my-crate
cargo owner --add georust/my-crate-publishers

If you had previously granted another team, like all of georust/core publishing
permissions, it should be revoked so that only the smallest group necessary has
publishing access.

cargo owner --remove georust/core

If your crate had additional folks publishing, be sure that they're either a
crates.io user-owner or add them to your new georust/_my-crate_-publishing
team.

0 comments on commit 5b4cbdb

Please sign in to comment.