Skip to content

Commit

Permalink
align examples better with days 1 and 2; closes #275
Browse files Browse the repository at this point in the history
I still need to document the walk-throughs ...
  • Loading branch information
bast committed Mar 13, 2024
1 parent da217ed commit 94e08e7
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 3 deletions.
7 changes: 6 additions & 1 deletion content/code-review.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# Practicing code review

We will add more details and screenshots before the course.
In this episode we will practice the code review process. We will learn how to
ask for changes in a pull request, how to suggest a change in a pull request,
and how to modify a pull request.

This will enable research groups to work more collaboratively and to not only
improve the code quality but also to learn from each other.


## Exercise
Expand Down
13 changes: 12 additions & 1 deletion content/forking-workflow.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# How to contribute changes to repositories that belong to others

In this episode we prepare you to suggest and contribute changes to
repositories that belong to others. These might be open source projects that
you use in your work.

We will add more details and screenshots before the course.
We will see how Git and services like GitHub or GitLab can be used to suggest
modification without having to ask for write access to the repository and
accept modifications without having to grant write access to others.


## Exercise
Expand All @@ -19,6 +24,7 @@ We will add more details and screenshots before the course.

**What will be new** in this exercise:
- Opening a pull request towards the upstream repository.
- Pull requests can be coupled with automated testing.
- Learning that your fork can get out of date.
- After the pull requests are merged, updating your fork with the changes.
- Learn how to approach other people's repositories with ideas, changes, and requests.
Expand All @@ -30,6 +36,11 @@ We will add more details and screenshots before the course.
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. Team leaders will merge the pull requests. For individual participants, the
instructors and workshop organizers will review and merge the pull requests.
During the review, pay attention to the automated test step (here for
demonstration purposes, we test whether the recipe contains an ingredients
and an instructions sections).
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
7 changes: 6 additions & 1 deletion content/same-repository.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# Collaborating within the same repository

We will add more details and screenshots before the course.
In this episode, we will learn how to collaborate within the same repository.
We will learn how to cross-reference issues and pull requests, how to review
pull requests, and how to use draft pull requests.

This exercise will form a good basis for collaboration that is suitable for
most research groups.


## Exercise
Expand Down

0 comments on commit 94e08e7

Please sign in to comment.