Skip to content

Commit 1e6dd75

Browse files
Merge pull request #49 from kir-rescomp/dev
new supplementary page on forking
2 parents c7e1546 + fbfeba1 commit 1e6dd75

File tree

2 files changed

+30
-31
lines changed

2 files changed

+30
-31
lines changed

docs/5.from_git_to_github.md

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -295,37 +295,6 @@ flowchart LR
295295

296296
---
297297

298-
## 8. Forking — External Contributions
299-
300-
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.
301-
302-
### Forking workflow:
303-
304-
1. **Fork**: Click "Fork" on GitHub → creates copy under their account
305-
2. **Clone their fork**:
306-
````bash
307-
git clone https://github.com/PostdocZ/CellClusterFlow.git
308-
````
309-
3. **Make changes** on a new branch
310-
4. **Push to their fork**
311-
5. **Open a Pull Request** from their fork back to Dr. X's original repo
312-
````mermaid
313-
flowchart TB
314-
ORIG[DrX/CellClusterFlow<br/>Original repo]
315-
FORK[PostdocZ/CellClusterFlow<br/>Forked repo]
316-
317-
ORIG -->|Fork| FORK
318-
FORK -->|Make changes| FORK
319-
FORK -->|Pull Request| ORIG
320-
321-
style ORIG fill:#e6ffe6,stroke:#333
322-
style FORK fill:#e6f7ff,stroke:#333
323-
````
324-
325-
This is how **open-source** contributions work — anyone can suggest improvements without needing direct access!
326-
327-
---
328-
329298
## 10. README and Documentation
330299

331300
A good `README.md` is like a well-written Methods section — it should help others reproduce your work.

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)