Commit c308187f authored by micah's avatar micah 💬
Browse files

Fix formatting

parent 3939ca12

README.md

+8 −9
Original line number Diff line number Diff line
@@ -78,11 +78,11 @@ Create an issue in the issue tracker and use the `Fork request` [issue template] 


- You must be an **Owner** of the `tor-contributors` group



### 1. Join the `tor-contributors` group (if not already a member)

### Join the `tor-contributors` group (if not already a member)



Ask an admin for access as **Maintainer** or above.



### 2. Determine the right structure and create if needed

### Determine the right structure and create if needed



The standard is to create a structure matching the full path of the upstream project.

For example, the [oniux project](https://gitlab.torproject.org/tpo/core/oniux)
@@ -90,14 +90,14 @@ is forked from `tpo/core/oniux` to [`tor-contributors/tpo/core/oniux`](https://g 


Create the group hierarchy, if it doesn't exist.



### 3. Fork the source project

### Fork the source project



Go to the source project (e.g., `https://gitlab.torproject.org/tpo/core/oniux`) and click **Fork**.



- **Target Namespace**: `tor-contributors/tpo/<path structure>`

- **Project Name**: Keep the same name as the source (e.g., `oniux`)



#### 4. Set up pull mirroring

#### Set up pull mirroring



In the new fork:
@@ -110,7 +110,7 @@ In the new fork: 
  - Overwrite diverged branches

  - Do not trigger pipelines for mirror updates



### 5. Protect the `main` branch

### Protect the `main` branch



- Go to **Repository → Branches → Default branch (`main`)**

- Set protection rules:
@@ -119,12 +119,11 @@ In the new fork: 


This prevents contributors from accidentally pushing to `main`.



### 6. Add project label in `members`

### Add project label in `members`



In the `tor-contributors/members` project add a label following the convention `project::oniux`



### 7. Update canonical project

Reach out to a maintainer of the canonical project and ask them to:

### Update canonical project



##### [Add a project badge](https://docs.gitlab.com/ee/user/project/badges.html#add-a-badge)

- Name: `Community fork`.
@@ -132,7 +131,7 @@ Reach out to a maintainer of the canonical project and ask them to: 
- Badge image url: `https://img.shields.io/badge/Contribute-community%20fork-blue`.



##### Update project docs

Update the `README.md` or `CONTRIBUTING.md` to include contribution information:

Create a merge request in the canonical project that updates the `README.md` or `CONTRIBUTING.md` to include contribution information, for example:



`[![Contribute via Community Fork](https://img.shields.io/badge/contribute-community--fork-blue)](https://gitlab.torproject.org/tor-contributors/tpo/core/oniux)`