Skip to content

Commit

Permalink
improve first exercise
Browse files Browse the repository at this point in the history
  • Loading branch information
bast committed Mar 6, 2024
1 parent 4fad2b5 commit 193024f
Showing 1 changed file with 35 additions and 17 deletions.
52 changes: 35 additions & 17 deletions content/browsing.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,42 @@
# 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?
```

```{instructor-note} Preparation for instructors
```{instructor-note}
Preparation:
- Create an exercise repository from
<https://github.com/coderefinery/recipe-book-template> preserving history
(this means not by "generating from template")
(this means not using "generating from template")
- Create one or two issues
- Create one or two pull requests
- Try to search for something in the recipe to trigger a search index update
Before starting the exercise session:
- Show how to fork the repository to own account
```

```{exercise} Exercise: Browsing an existing project (25 min)
First **make a copy** to your own account to work on **by forking**
<https://github.com/coderefinery/recipe-book>
Then browse the project and explore commits and branches. Take notes and prepare questions.
1. Browse the commit history: Are commit messages understandable?
1. Compare the commit history with the network graph ("Insights" -> "Network"). Can you find the branches?
1. How can you find out when a recipe was last modified?
1. How many changes did the Guacamole recipe receive? Try to click on some of the commits to see what changed.
1. Which recipes include "salt"?
1. In the Guacamole recipe, find out who modified each line last and when
(click on file, then click "Blame" button). Find out who added the cilantro
and in which commit.
1. Who all has contributed to the repository?
1. Can you use these recipes yourself? Are you allowed to share modifications? (look at the license file)
1. Browse issues and pull requests, any idea what these might be good for?
```

We will add to this page:
- intro
- screenshots
- tab on how to do this locally
- hints
- solution
- discussion
- summary

0 comments on commit 193024f

Please sign in to comment.