CodeYourFuture / syllabus

Old Syllabus Website for CodeYourFuture
https://syllabus.codeyourfuture.io
154 stars 123 forks source link

How should we introduce Git branching strategies? #721

Closed 40thieves closed 1 year ago

40thieves commented 1 year ago

What is the hypothesis?

In the new Git introduction, we introduce creating a branch.

Previously we structured the coursework so that there was one repo per week, and so multiple branches per repo wasn't necessary (caveat: the React coursework did not follow this structure, which caused it's own problems).

The Git introduction above only introduces creating a single branch and it will be necessary for trainees to create multiple branches (with matching PRs), for example one branch for week-1, one branch for week-2, etc. We therefore should discuss which branches strategies we want to introduce and where within the course they should brought up.

Why is this important?

Given the above, trainees will inevitably encounter multiple branches, so I think we should prepare them with basic branching strategies.

For the trainees, the simplest strategy would be to branch off from the current branch, or in other words, create the week-2 branch based on the week-1 branch. However this may mean extra "noise" in the PR diff for trainees/volunteers, making it harder to review the coursework.