Skip to content

Commit 4680940

Browse files
add a supplementary page on real world scenarios
1 parent 77c4e60 commit 4680940

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Real-World Research Scenarios
2+
3+
### 🔬 Scenario 1: Publishing alongside a paper
4+
````bash
5+
# Make repository public before paper submission
6+
# Tag the version used in the paper
7+
git tag -a v1.0-paper -m "Code for Smith et al. 2025"
8+
git push origin v1.0-paper
9+
10+
# Add DOI from Zenodo for citability
11+
````
12+
13+
### 🤝 Scenario 2: Multi-lab collaboration
14+
````bash
15+
# Add collaborator's fork as remote
16+
git remote add collaborator https://github.com/CollabLab/CellClusterFlow.git
17+
18+
# Fetch their branches
19+
git fetch collaborator
20+
21+
# Review their work
22+
git checkout collaborator/new-algorithm
23+
````
24+
25+
### 📚 Scenario 3: Archiving for reproducibility
26+
- Link GitHub repo in paper's Data Availability section
27+
- Use Zenodo integration for permanent DOI
28+
- Include `environment.yml` or `requirements.txt` for exact dependencies
29+
30+
---

0 commit comments

Comments
 (0)