Skip to content

Commit abe8ebb

Browse files
Adding TRANSFER.md instructions for transferring to the REC (#24)
* Adding TRANSFER.md instructions for transferring to the REC * Removing optional ownership on crates.io * Updating TRANSFER instructions after review * Update TRANSFER.md Co-authored-by: Diego Barrios Romero <[email protected]> * Update TRANSFER.md Co-authored-by: Diego Barrios Romero <[email protected]> * Fix cargo owner user handle template * Fixing syntax --------- Co-authored-by: Diego Barrios Romero <[email protected]>
1 parent 873392a commit abe8ebb

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ We haven't really worked out any rules as to what we will and won't look after,
4545

4646
If you'd like to suggest a project to be moved to the community, please open an issue and tell us about it.
4747

48+
For detailed instructions on how to transfer repositories, please refer to [TRANSFER.md](TRANSFER.md).
49+
4850
## Crates.io
4951

5052
We're happy to be added as Owners on crates.io for projects we host. We can then help co-ordinate pushing out updates when something elsewhere in the ecosystem causes breakage. Open an issue if you want to discuss this.

TRANSFER.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Instructions for Crate Transfer
2+
3+
This document outlines the necessary steps to transfer a project to the rust-embedded-community
4+
project.
5+
6+
Users that are interested in their transfer can retain original ownership and write-control to any
7+
projects that they wish to transfer as well.
8+
9+
## Process
10+
11+
The process for transferring ownership depends on whether or not the original crate owner would like
12+
to join the `rust-embedded-community` project.
13+
14+
### Transfer Process (Joining the R-E-C)
15+
16+
This process is used if the original crate owner would like to become a member of the
17+
`rust-embedded-community` project.
18+
19+
1. Request to join the community by following the steps outlined [here](README.md#joining-the-community).
20+
1. Once you have been added, request to transfer the repository under the repository settings:
21+
1. Navigate to transfer the repository under the repository settings.
22+
`https://github.com/<YOUR-ORG>/<YOUR-REPO>/settings`: General > Danger Zone > "Transfer
23+
ownership"
24+
2. Select "Specify an organization or username" and supply `rust-embedded-community`
25+
3. Confirm the transfer and select "I understand, transfer this repository"
26+
27+
2. Add the rust-embedded-community project to the crates.io owners to allow the community
28+
to issue updated releases for the crate:
29+
```sh
30+
cargo owner --add github:rust-embedded-community:all
31+
```
32+
33+
### Transfer Process (Without Joining)
34+
35+
The following process can be used if the original crate owner does not wish to join the
36+
`rust-embedded-community`.
37+
38+
1. Request to transfer the repository under the repository settings:
39+
1. Navigate to transfer the repository under the repository settings.
40+
`https://github.com/<YOUR-ORG>/<YOUR-REPO>/settings`: General > Danger Zone > "Transfer
41+
ownership"
42+
2. Select "Specify an organization or username" and supply the Github username of one of the
43+
`rust-embedded-community` members that you have been previously in contact with about
44+
transferring the repository.
45+
* If you haven't been in contact with anyone yet, feel free to [open an issue](https://github.com/rust-embedded-community/meta/issues/new) and one of us will be
46+
happy to assist.
47+
3. Confirm the transfer and select "I understand, transfer this repository"
48+
4. Add the contact person to the crates.io owners to allow them to allow the community
49+
to issue updated releases for the crate:
50+
```sh
51+
cargo owner --add <MEMBER-GITHUB-ID>
52+
```
53+
54+
Once the repository is transferred to the organizational member, that member should follow the steps
55+
outlined above for transferring to the `rust-embedded-comunity`.

0 commit comments

Comments
 (0)