Skip to content

Commit

Permalink
prepare a lesson structure - still a long way to go
Browse files Browse the repository at this point in the history
  • Loading branch information
bast committed Mar 5, 2024
1 parent f2fd255 commit e1ebd80
Show file tree
Hide file tree
Showing 7 changed files with 89 additions and 6 deletions.
16 changes: 16 additions & 0 deletions content/browsing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Copy and browse an existing project

```{exercise} Browsing an existing project (20 min)
- Make a copy to work on (fork repository) <https://github.com/coderefinery/recipe-book>
- Browse commits and branches
- Explore few things, take notes, and prepare questions
- "grep": Which foods include a certain ingredient?
- Annotate: Who has contributed to this recipe?
At which commit did an ingredient get introduced or modified?
- Contributors page: Who all has contributed?
- How old is each recipe, and how many changes? (look at history)
- When was each recipe last modified? (file browser)
- Can you use these recipes yourself? (license)
- Browse issues and pull requests, any idea what these might be good for?
- Browse commit history: are commit messages understandable?
```
10 changes: 10 additions & 0 deletions content/commits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Committing changes

```{exercise} Practice creating commmits and branches (20 min)
- create a branch and commit to it
- maybe also commit to main
- browse network
- compare branches
- compare commits
- rename a branch
```
1 change: 1 addition & 0 deletions content/conflict-resolution.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Conflict resolution
45 changes: 40 additions & 5 deletions content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,53 @@ branching.

```{toctree}
:maxdepth: 1
:caption: Core episodes
:caption: Getting started
motivation
basics
branches
conflicts
remotes
```

```{toctree}
:maxdepth: 1
:caption: Modifying an existing project
browsing
commits
merging
conflict-resolution
local-workflow
```

```{toctree}
:maxdepth: 1
:caption: Studying an existing project
archaeology
```

```{toctree}
:maxdepth: 1
:caption: Sharing your work
sharing
```

```{toctree}
:maxdepth: 1
:caption: Finding the balance
level
what-to-avoid
```

```{toctree}
:maxdepth: 1
:caption: Previous episodes (WIP)
basics
branches
conflicts
```

```{toctree}
:maxdepth: 1
:caption: Optional episodes
Expand Down
5 changes: 5 additions & 0 deletions content/local-workflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Working locally on a Git repository

- What is Git, and what is a Git repository?
- Configuring Git command line and editor
- Exercise: config/clone/commit/branch/graph
16 changes: 16 additions & 0 deletions content/merging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Merging changes and contribute to the project

```{exercise} Merging branches with pull requests (20 min)
- select from which to which
- be careful about whether this is towards main on your copy or the repo where we forked from
- browse network
- optional: try also to send a PR towards the central repo (we merge few of those)
- how to find out which branches are safe to delete?
```

Demo:
- conflict
- delete branches
- create release (or optional exercise step)

Quiz: how to find out which branches are safe to delete?
2 changes: 1 addition & 1 deletion content/remotes.md → content/sharing.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sharing repositories online
# How to turn your project to a Git repo and share it

```{objectives}
- We get a feeling for remote repositories ([more later](https://coderefinery.github.io/git-collaborative/)).
Expand Down

0 comments on commit e1ebd80

Please sign in to comment.