Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
76 commits
Select commit Hold shift + click to select a range
f67650b
High level structural change to the code review section
thomaskileyukaea Jul 27, 2023
1fa9a33
Make exercises use the correct syntax to work
thomaskileyukaea Jul 27, 2023
dc0a6c8
Add exercise for initial code review
thomaskileyukaea Jul 27, 2023
d9cbea7
Add exercise for reviewing code looking for sufficent tests
thomaskileyukaea Jul 27, 2023
10a93a1
Fix missing blockquote marker
thomaskileyukaea Jul 27, 2023
83d77d1
Add exercise for responding to review comments
thomaskileyukaea Jul 27, 2023
3b1930f
Make solution comment follow guidelines of providing an actionable al…
thomaskileyukaea Jul 27, 2023
8fd3ead
Add section on what to look out for in a code review
thomaskileyukaea Jul 27, 2023
344374d
Add section about how to check code is suitably tested and correct
thomaskileyukaea Jul 27, 2023
9e7fffb
Fix spelling mistake of embarrassement
thomaskileyukaea Jul 27, 2023
0bbf46c
Add a section on what not to look for in a code review
thomaskileyukaea Aug 1, 2023
abbda40
Add section on responding to review comments
thomaskileyukaea Aug 1, 2023
4ce0614
Add section about making code easy to review
thomaskileyukaea Aug 1, 2023
a2a2457
Add section about empathy in review
thomaskileyukaea Aug 1, 2023
cd06ebd
Add considerations for a code review process
thomaskileyukaea Aug 1, 2023
36aa45d
Add back in the different kinds of code review
thomaskileyukaea Aug 4, 2023
6bfdf16
Rework the code review in action section
thomaskileyukaea Aug 4, 2023
606f996
Update the section about raising a review
thomaskileyukaea Aug 4, 2023
473fca6
Update closing pull request for new exercise structure
thomaskileyukaea Aug 4, 2023
390fc7e
Merge suggestion for trying code review techniques into the intro
thomaskileyukaea Aug 4, 2023
03a5919
Remove bit about sticking to a process
thomaskileyukaea Aug 4, 2023
a973929
Move citations for length of time spent reviewing and code length inline
thomaskileyukaea Aug 4, 2023
30e46d1
Move additional reading links to the end of the episode
thomaskileyukaea Aug 4, 2023
987f052
Remove discussion about timings as covered in Designing a review process
thomaskileyukaea Aug 4, 2023
83dd9c3
Add more references to the size of PR
thomaskileyukaea Aug 4, 2023
27cb1c6
Remove instruction to use branches
thomaskileyukaea Aug 4, 2023
4260e2c
Remove advice about force pushing
thomaskileyukaea Aug 4, 2023
3778392
Move info about using PR states in GH to process section
thomaskileyukaea Aug 4, 2023
a7bbb4d
Remove linting advice as covered in what not to review
thomaskileyukaea Aug 4, 2023
8b3496f
Remove empty section
thomaskileyukaea Aug 4, 2023
15eed1a
Line by line edit of new content
thomaskileyukaea Aug 4, 2023
852f99e
Update final exercise to be more related to the process
thomaskileyukaea Aug 4, 2023
58cabd0
Remove diagram
thomaskileyukaea Aug 4, 2023
cb9ea5e
Add screenshots for responding to a comment and reacting with an emoji
thomaskileyukaea Aug 4, 2023
5e21b79
Update screenshots for the new branch names
thomaskileyukaea Aug 4, 2023
0837e9c
Add some semantic breaks
thomaskileyukaea Aug 4, 2023
2455ac5
Use busienss logic to make the advice clearer
thomaskileyukaea Aug 4, 2023
8377e2d
Final read through small tweaks
thomaskileyukaea Aug 4, 2023
9e1e0e2
Move the don't re-design code in review to the don't look for section
thomaskileyukaea Aug 4, 2023
8064cb8
Made the instructions for creating a pull request more robust
thomaskileyukaea Aug 8, 2023
8de8d65
Move the instructions about reviewing PRs to after what to look for
thomaskileyukaea Aug 9, 2023
0039058
Move headers up one level in indentation
thomaskileyukaea Aug 9, 2023
ec5f147
Add point about code consistency
thomaskileyukaea Aug 9, 2023
1343e65
Add a section on how to add a review comment
thomaskileyukaea Aug 9, 2023
b4dfba8
Explain where to request tests and how to submit a review
thomaskileyukaea Aug 9, 2023
f4f1b08
Use the word compare rather than head
thomaskileyukaea Aug 9, 2023
1217dd6
Add semantic break
thomaskileyukaea Aug 9, 2023
ac402a4
Introduce the abbreviation PR for pull request
thomaskileyukaea Aug 9, 2023
d3fb46f
Add semantic break
thomaskileyukaea Aug 9, 2023
b437fcb
Explicitly state how to approve a PR
thomaskileyukaea Aug 9, 2023
1ce2073
Adapt closing a pull request for new exercise
thomaskileyukaea Aug 9, 2023
f422334
Semantic break
thomaskileyukaea Aug 9, 2023
436941e
Small tweaks to the final section of the episode
thomaskileyukaea Aug 9, 2023
aa4906a
Update timings based on dry run of the episode
thomaskileyukaea Aug 9, 2023
2f1b87c
Include links and a short description of the different kind of code r…
thomaskileyukaea Sep 19, 2023
5929cb4
Introduce semantic break in code review types section
thomaskileyukaea Sep 19, 2023
85de450
Incorporate the initial exercise more fully into the final exercise
thomaskileyukaea Sep 19, 2023
5efd004
Refer to modularity rather than to design patterns
thomaskileyukaea Sep 19, 2023
153df42
Split points for code structure into separate paragraphs
thomaskileyukaea Sep 19, 2023
1935072
Split points for documentation into separate paragraphs
thomaskileyukaea Sep 19, 2023
dd118e7
Add a diagram showing the structrure of a code review
thomaskileyukaea Sep 22, 2023
270f2a1
Make effective review comments part of adding a comment
thomaskileyukaea Sep 22, 2023
66e5512
Adjust header levels for clarity
thomaskileyukaea Sep 22, 2023
9e7dc11
Make effective review comments a callout
thomaskileyukaea Sep 22, 2023
f69761f
CMove what not to look for into a callout
thomaskileyukaea Sep 22, 2023
0b50701
Use bullet points for the different code review responses
thomaskileyukaea Sep 22, 2023
62d6a56
Use bullet points for the code quality guidance
thomaskileyukaea Sep 22, 2023
6654646
Add a bullet point summary to making code easy to review
thomaskileyukaea Sep 22, 2023
221d0c4
Use width rather than ehight for timeline sizing
thomaskileyukaea Sep 22, 2023
515b8de
Include mermaid text for the diagram
thomaskileyukaea Sep 22, 2023
b39c6d1
Add to diagram that the author should merge the PR when done
thomaskileyukaea Sep 22, 2023
cede4a1
Merge remote-tracking branch 'upstream/gh-pages' into rework-review-s…
thomaskileyukaea Sep 22, 2023
4f9eab4
Embed the mermaid diagram directly in the page
thomaskileyukaea Sep 22, 2023
a6e93e2
Centre the sequence diagram
thomaskileyukaea Sep 22, 2023
6542fa6
Make the background colour of diagrams white
thomaskileyukaea Sep 22, 2023
c300114
Use episode template rather than lesson template for mermaid
thomaskileyukaea Oct 10, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
803 changes: 480 additions & 323 deletions _episodes/41-code-review.md

Large diffs are not rendered by default.

22 changes: 22 additions & 0 deletions _layouts/episode_mermaid.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
layout: episode
---
{{ content }}
<script src="https://unpkg.com/mermaid@8.9.3/dist/mermaid.min.js"></script>
<script>
document.addEventListener("DOMContentLoaded", function(){
mermaid.initialize({
startOnLoad:true,
theme: "default",
});
window.mermaid.init(undefined, document.querySelectorAll('.language-mermaid'));
});
</script>
<!--Below styling is required to centre the SVG -->
<style>
.language-mermaid>svg {
background-color: white;
width: 100%;
margin: auto;
}
</style>
433 changes: 0 additions & 433 deletions fig/exercise-feature-branch.svg

This file was deleted.

Binary file added fig/github-add-emoji.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified fig/github-create-pull-request.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified fig/github-merge-pull-request.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added fig/github-pull-request-add-comment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added fig/github-pull-request-add-suggestion.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added fig/github-pull-request-files-changed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added fig/github-pull-request-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added fig/github-respond-to-review-comment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added fig/github-submit-pr-review.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added fig/github-submit-pullrequest.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.