Skip to content

Commit 6e7ef9a

Browse files
Add VSCode alternative note and link to existing branching notes
1 parent 816c41f commit 6e7ef9a

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

  • common-content/en/blocks/git-branching-workshop

common-content/en/blocks/git-branching-workshop/index.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ This workshop addresses a problem we see regularly: trainees submit PRs that con
2020

2121
Before this workshop, make sure you have completed [Using GitHub](../using-github) and read the [Trainee PR Guide](../../guides/reviewing/trainee-pr-guide).
2222

23+
Also look at the [branching notes in the Onboarding module](https://curriculum.codeyourfuture.io/itp/onboarding/sprints/1/prep/#branching) for a visual guide to creating branches.
24+
2325
## The Core Problem
2426

2527
When you submit coursework, each piece should come from its own branch. If you make two pieces of coursework on the same branch, your PR for coursework B will also contain all the commits from coursework A. This makes it impossible to review and merge them separately.
@@ -35,7 +37,9 @@ This workshop will show you:
3537

3638
### Exercise: Map the Branch Structure
3739

38-
Look at this diagram of a repository:
40+
Look at these two diagrams of a repository.
41+
42+
**Diagram 1: Clean branch structure**
3943

4044
```mermaid
4145
gitGraph
@@ -49,7 +53,7 @@ gitGraph
4953
commit id: "E"
5054
```
5155

52-
And this PR that was submitted:
56+
**Diagram 2: Problem - topic-2 was branched from topic-1, not main**
5357

5458
```mermaid
5559
gitGraph
@@ -88,6 +92,8 @@ Your trainer will share a link to a practice repository. For this exercise, you
8892

8993
**Important:** Each branch must be created from `main`, not from the other branch.
9094

95+
These steps use the terminal. If you prefer, you can do this in VSCode using the Source Control panel instead -- the concepts are the same, only the interface is different.
96+
9197
**Step 1: Branch for Coursework 1**
9298

9399
- Clone the repository

0 commit comments

Comments
 (0)