File tree Expand file tree Collapse file tree 2 files changed +30
-29
lines changed
Expand file tree Collapse file tree 2 files changed +30
-29
lines changed Original file line number Diff line number Diff line change @@ -282,36 +282,7 @@ flowchart TB
282282
283283---
284284
285- ## Real-World Research Scenarios
286285
287- ### 🔬 Scenario 1: Publishing alongside a paper
288- ```` bash
289- # Make repository public before paper submission
290- # Tag the version used in the paper
291- git tag -a v1.0-paper -m " Code for Smith et al. 2025"
292- git push origin v1.0-paper
293-
294- # Add DOI from Zenodo for citability
295- ````
296-
297- ### 🤝 Scenario 2: Multi-lab collaboration
298- ```` bash
299- # Add collaborator's fork as remote
300- git remote add collaborator https://github.com/CollabLab/CellClusterFlow.git
301-
302- # Fetch their branches
303- git fetch collaborator
304-
305- # Review their work
306- git checkout collaborator/new-algorithm
307- ````
308-
309- ### 📚 Scenario 3: Archiving for reproducibility
310- - Link GitHub repo in paper's Data Availability section
311- - Use Zenodo integration for permanent DOI
312- - Include ` environment.yml ` or ` requirements.txt ` for exact dependencies
313-
314- ---
315286
316287## Best Practices for Research Code
317288
Original file line number Diff line number Diff line change 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+ ---
You can’t perform that action at this time.
0 commit comments