Skip to content

Commit

Permalink
improve exercise steps, reorder exercises 2 and 3
Browse files Browse the repository at this point in the history
  • Loading branch information
bast committed Mar 13, 2024
1 parent 1e89b04 commit eb1a6ae
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 7 deletions.
6 changes: 4 additions & 2 deletions content/code-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,16 @@ We will add more details and screenshots before the course.
**What will be new** in this exercise:
- As a reviewer, we will learn how to ask for changes in a pull request.
- As a reviewer, we will learn how to suggest a change in a pull request.
- As a submitter, we will learn how to modify a pull request without closing and opening a new one.
- As a submitter, we will learn how to modify a pull request without closing
the incomplete one and opening a new one.

**Exercise tasks**:
1. Create a new branch and one or few commits: in these improve something but also
deliberately introduce a typo and also a larger mistake which we will want to fix during the code review.
1. Open a pull request towards the main branch.
1. As a reviewer to somebody else's pull request, ask for an improvement and
also suggest a change for the small typo.
also directly suggest a change for the small typo.
1. As the submitter, learn how to accept the suggested change.
1. As the submitter, improve the pull request without having to close and open
a new one: by adding a new commit to the same branch.
1. Once the changes are addressed, merge the pull request.
Expand Down
7 changes: 5 additions & 2 deletions content/forking-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,14 @@ We will add more details and screenshots before the course.
- Learn how to approach other people's repositories with ideas, changes, and requests.

**Exercise tasks**:
1. Open an issue where you describe the change you want to make.
1. Create a new branch.
1. Open an issue in the upstream exercise repository where you describe the
change you want to make. Take note of the issue number.
1. Create a new branch in your fork of the repository.
1. Make a change to the recipe book on the new branch and in the commit cross-reference the issue you opened.
See the walk-through below for how to do this.
1. Open a pull request towards the upstream repository.
1. After few pull requests are merged, update your fork with the changes.
1. Check that in your fork you can see changes from other people's pull requests.
:::


Expand Down
2 changes: 1 addition & 1 deletion content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ to host your Git repository on another platform.
concepts.md
same-repository.md
forking-workflow.md
code-review.md
forking-workflow.md
```

```{toctree}
Expand Down
7 changes: 5 additions & 2 deletions content/same-repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ We will add more details and screenshots before the course.
:::{exercise} Exercise: Collaborating within the same repository (25 min)

**What is familiar** from the previous workshop days:
- Cloning a repository.
- Creating a branch.
- Committing a change on the new branch.
- Submit a pull request towards the main branch.
Expand All @@ -20,9 +21,11 @@ We will add more details and screenshots before the course.
- Learn about the value of draft pull requests.

**Exercise tasks**:
1. Open an issue where you describe the change you want to make.
1. Open an issue where you describe the change you want to make. Note down the
issue number since you will need it later.
1. Create a new branch.
1. Make a change to the recipe book on the new branch and in the commit cross-reference the issue you opened.
1. Make a change to the recipe book on the new branch and in the commit
cross-reference the issue you opened (see the walk-through below for how to do that).
1. Open a pull request towards the main branch.
1. Review somebody else's pull request and give constructive feedback.
1. Try to create a new branch with some half-finished work and open a draft
Expand Down

0 comments on commit eb1a6ae

Please sign in to comment.