Skip to content

Commit f54d040

Browse files
Merge pull request #50 from kir-rescomp/dev
remove additional resources section from intro to Github episode as they are already included in the index page
2 parents 1e6dd75 + 9b38fea commit f54d040

File tree

2 files changed

+48
-59
lines changed

2 files changed

+48
-59
lines changed

docs/5.from_git_to_github.md

Lines changed: 0 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -242,56 +242,6 @@ flowchart TB
242242
- **Request specific reviewers** — tag people with expertise
243243
- **Respond to feedback** — science is iterative!
244244

245-
---
246-
247-
## 7. Issues — Tracking Bugs and Ideas
248-
249-
A user tries the pipeline and finds a bug. Instead of emailing, they open an **Issue**:
250-
251-
### On GitHub:
252-
1. Click **"Issues"****"New issue"**
253-
2. Title: `Error in QC filtering with empty cells`
254-
3. Description:
255-
````markdown
256-
## Bug description
257-
When running `qc_filtering.py` on a dataset with empty droplets,
258-
the script crashes with:
259-
````
260-
IndexError: list index out of range
261-
````
262-
263-
## Steps to reproduce
264-
1. Load dataset with empty cells: `adata = load_data("empty_drops.h5ad")`
265-
2. Run: `qc_filtering.py --min-genes 200`
266-
267-
## Expected behavior
268-
Should filter out empty cells without crashing
269-
270-
## System info
271-
- Python 3.9
272-
- scanpy 1.9.1
273-
````
274-
4. Add labels: `bug`, `priority:high`
275-
5. Submit issue (#15)
276-
277-
Dr. X sees the issue, creates a branch `fix-empty-cells`, fixes the bug, and references it in the commit:
278-
````bash
279-
git commit -m "Fix QC filtering for empty cells (fixes #15)"
280-
````
281-
282-
When merged, issue #15 automatically closes!
283-
````mermaid
284-
flowchart LR
285-
A[User finds bug] --> B[Open Issue #15]
286-
B --> C[Dr. X creates fix-empty-cells branch]
287-
C --> D[Commit: 'fixes #15']
288-
D --> E[Pull Request]
289-
E --> F[Merge to main]
290-
F --> G[Issue #15 auto-closes]
291-
292-
style B fill:#ffe6e6,stroke:#f00
293-
style G fill:#e6ffe6,stroke:#0a0
294-
````
295245

296246
---
297247

@@ -497,14 +447,5 @@ Now that Dr. X's pipeline is on GitHub:
497447

498448
---
499449

500-
## Additional Resources
501-
502-
- [GitHub Skills](https://skills.github.com/) — Interactive tutorials
503-
- [GitHub Docs](https://docs.github.com/) — Official documentation
504-
- [Git Flight Rules](https://github.com/k88hudson/git-flight-rules) — What to do when things go wrong
505-
- [Conventional Commits](https://www.conventionalcommits.org/) — Standardized commit messages
506-
507-
---
508-
509450
!!! quote "Remember"
510451
"Science is not a solo sport. Git tracks your journey; GitHub shares it with the world." 🚀
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Issues — Tracking Bugs and Ideas
2+
3+
A user tries the pipeline and finds a bug. Instead of emailing, they open an **Issue**:
4+
5+
### On GitHub:
6+
1. Click **"Issues"****"New issue"**
7+
2. Title: `Error in QC filtering with empty cells`
8+
3. Description:
9+
````markdown
10+
## Bug description
11+
When running `qc_filtering.py` on a dataset with empty droplets,
12+
the script crashes with:
13+
````
14+
IndexError: list index out of range
15+
````
16+
17+
## Steps to reproduce
18+
1. Load dataset with empty cells: `adata = load_data("empty_drops.h5ad")`
19+
2. Run: `qc_filtering.py --min-genes 200`
20+
21+
## Expected behavior
22+
Should filter out empty cells without crashing
23+
24+
## System info
25+
- Python 3.9
26+
- scanpy 1.9.1
27+
````
28+
4. Add labels: `bug`, `priority:high`
29+
5. Submit issue (#15)
30+
31+
Dr. X sees the issue, creates a branch `fix-empty-cells`, fixes the bug, and references it in the commit:
32+
````bash
33+
git commit -m "Fix QC filtering for empty cells (fixes #15)"
34+
````
35+
36+
When merged, issue #15 automatically closes!
37+
````mermaid
38+
flowchart LR
39+
A[User finds bug] --> B[Open Issue #15]
40+
B --> C[Dr. X creates fix-empty-cells branch]
41+
C --> D[Commit: 'fixes #15']
42+
D --> E[Pull Request]
43+
E --> F[Merge to main]
44+
F --> G[Issue #15 auto-closes]
45+
46+
style B fill:#ffe6e6,stroke:#f00
47+
style G fill:#e6ffe6,stroke:#0a0
48+
````

0 commit comments

Comments
 (0)