Skip to content

Commit fbfeba1

Browse files
new supplementary page on forking
1 parent 5847678 commit fbfeba1

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/supplementary/2.forking.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Forking — External Contributions
2+
3+
A postdoc from another university wants to adapt `CellClusterFlow` for their spatial transcriptomics data. They can't push directly (no write access), so they **fork** the repository.
4+
5+
### Forking workflow:
6+
7+
1. **Fork**: Click "Fork" on GitHub → creates copy under their account
8+
2. **Clone their fork**:
9+
````bash
10+
git clone https://github.com/PostdocZ/CellClusterFlow.git
11+
````
12+
3. **Make changes** on a new branch
13+
4. **Push to their fork**
14+
5. **Open a Pull Request** from their fork back to Dr. X's original repo
15+
````mermaid
16+
flowchart TB
17+
ORIG[DrX/CellClusterFlow<br/>Original repo]
18+
FORK[PostdocZ/CellClusterFlow<br/>Forked repo]
19+
20+
ORIG -->|Fork| FORK
21+
FORK -->|Make changes| FORK
22+
FORK -->|Pull Request| ORIG
23+
24+
style ORIG fill:#e6ffe6,stroke:#333
25+
style FORK fill:#e6f7ff,stroke:#333
26+
````
27+
28+
This is how **open-source** contributions work — anyone can suggest improvements without needing direct access!
29+
30+
---

0 commit comments

Comments
 (0)