Skip to content

Commit

Permalink
Fix markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
richelbilderbeek committed Dec 20, 2024
1 parent 4cb353a commit b026ff6
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
9 changes: 6 additions & 3 deletions docs/common_practices/exercises/exercises_code_review.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Code review exercises

## Exercise 1: pair programming

In this exercise you will try out pair programming using the driver-navigator technique.

Remember that:

> The Driver is the person coding. She is focussed on completing the tiny goal at hand, ignoring larger issues for the moment. A driver should always talk through what she is doing while doing it.
>
> The Navigator is in the observer position, while the driver is typing. She reviews the code on-the-go, gives directions and shares thoughts. The navigator also has an eye on the larger issues, bugs, and makes notes of potential next steps or obstacles.

Check failure on line 12 in docs/common_practices/exercises/exercises_code_review.md

View workflow job for this annotation

GitHub Actions / check_markdown

Blank line inside blockquote
> **Martin Fowler, [On Pair Programming](https://martinfowler.com/articles/on-pair-programming.html)**
Expand All @@ -15,7 +17,8 @@ In this task you will have to:
1. Work in pairs and try to code the [Fibonacci function](https://en.wikipedia.org/wiki/Fibonacci_number) or other function suggested by an instructor.
2. Switch navigator/driver roles.
3. Work in pairs and try to code the [Tribonacci function](https://en.wikipedia.org/wiki/Generalizations_of_Fibonacci_numbers#Tribonacci_numbers) or other function suggested by an instructor.
> The tribonacci numbers are like the Fibonacci numbers, but instead of starting with two predetermined terms, the sequence starts with three predetermined terms and each term afterwards is the sum of the preceding three terms.

Check failure on line 20 in docs/common_practices/exercises/exercises_code_review.md

View workflow job for this annotation

GitHub Actions / check_markdown

Trailing spaces [Expected: 0 or 2; Actual: 1]
> The tribonacci numbers are like the Fibonacci numbers, but instead of starting with two predetermined terms, the sequence starts with three predetermined terms and each term afterwards is the sum of the preceding three terms.
## Exercise 2: when may I use Code Reviews?

Expand All @@ -30,7 +33,7 @@ Now think about how you typically develop code, and how you might institute code
> - How long would the activity take?
> - Who would ideally be involved?
> - Any particular practices you would use?
>
> The Code review exercise (from broken URL `https://carpentries-incubator.github.io/python-intermediate-development/41-code-review/index.html`)
> by [The Carpentries](https://carpentries.org/) is licensed under [CC BY 4.0](http://creativecommons.org/licenses/by/4.0/). Modifications were made to simplify contents.
Expand Down
6 changes: 4 additions & 2 deletions docs/common_practices/pages/notes_code_review_long.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Notes on code review

This material is based on the Code Review lecture by The Carpentries:

> [Code Review](https://carpentries-incubator.github.io/managing-computational-projects/13-codereview.html) by [The Carpentries](https://carpentries.org/) is licensed under [CC BY 4.0](http://creativecommons.org/licenses/by/4.0/). Modifications were made in several chapters.
Expand Down Expand Up @@ -77,7 +79,7 @@ Asynchronous feedback removes the time pressure but can be easily forgotten!
>
> Unlike traditional, “academic-style” peer review, most code review systems have several advantages: they’re rarely anonymous, they’re public-facing, and without the broker of an editor, contact between reviewer and reviewee can be direct and rapid.
> This means code review is typically a fast, flexible, and interactive process.
>
> ## Github features to help with code review (Click to see)
>
> **Commit changes**: uploading snapshots when the code changes. The history of all changes are therefore saved and can be reverted.
Expand Down Expand Up @@ -169,7 +171,7 @@ The penalty for finding a bug once all the figures have been produced and conclu
> - Learning better techniques
> - Reduced time debugging alone
> - Knowledge exchange and group cohesion
>
> ## For a group leader, the benefits include
>
> - Better understanding of the projects
Expand Down

0 comments on commit b026ff6

Please sign in to comment.