Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
106 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
0f5eccc
📝 🍱 Switch instructions for replicating the project repository
bielsnohr Oct 25, 2023
795c40f
✏️ Remove missed references to "template" repo
bielsnohr Oct 25, 2023
ada593b
🔀 Merge pull request #226 from thomaskileyukaea/rework-review-section
bielsnohr Nov 10, 2023
098619d
Merge recent updates from gh-pages, resolve conflicts
steve-crouch Nov 20, 2023
3e35a3a
Merge pull request #279 from carpentries-incubator/rework-code-review…
steve-crouch Nov 21, 2023
3b3c67a
Initial review and redo of screenshots
anenadic Nov 23, 2023
4181b6c
Replaced code review sequence diagram with svg
anenadic Nov 23, 2023
6c0e72e
Small wording change
anenadic Nov 23, 2023
3e95833
Various small changes, improving the flow.
anenadic Nov 24, 2023
7040bef
Various small changes, improving/adding screenshots
anenadic Nov 24, 2023
f5c555b
Typo fix
anenadic Nov 24, 2023
e46e2c6
Update _episodes/41-code-review.md
anenadic Nov 24, 2023
312e22f
Update _episodes/41-code-review.md
anenadic Nov 24, 2023
5f8f76e
Update _episodes/41-code-review.md
anenadic Nov 24, 2023
6ce277b
Update _episodes/41-code-review.md
anenadic Nov 24, 2023
f6a7ebc
Update _episodes/41-code-review.md
anenadic Nov 24, 2023
32a3361
Update _episodes/41-code-review.md
anenadic Nov 24, 2023
12d5e8f
Fixed screenshots. Added a callout about code review
anenadic Nov 24, 2023
7d2e104
Merge branch 'code-review-review' of github.com:carpentries-incubator…
anenadic Nov 24, 2023
3f623e5
Update _episodes/41-code-review.md
anenadic Nov 24, 2023
038f0ef
Update _episodes/41-code-review.md
anenadic Nov 24, 2023
f51ee2e
Update _episodes/41-code-review.md
anenadic Nov 24, 2023
8c2b376
Update _episodes/41-code-review.md
anenadic Nov 24, 2023
989c0bf
Update _episodes/41-code-review.md
anenadic Nov 24, 2023
2963d50
Merge pull request #251 from carpentries-incubator/bielsnohr/249-fork…
anenadic Nov 27, 2023
c51d1e1
Updated merge PR screenshot - high res and shows approved review
anenadic Nov 27, 2023
f5a1a0c
Redid screenshots in higher resolution.
anenadic Nov 27, 2023
415d8de
Merge pull request #282 from carpentries-incubator/code-review-review
anenadic Nov 27, 2023
32f7aab
Update _episodes/11-software-project.md
anenadic Nov 27, 2023
34c67a7
Merge pull request #285 from carpentries-incubator/249-fork-course-pr…
anenadic Nov 27, 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
45 changes: 24 additions & 21 deletions _episodes/11-software-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,50 +54,53 @@ to fix and build on top of the existing code during the course.

## Downloading Our Software Project

To start working on the project, you will first
create a copy of the software project template repository
To start working on the project, you will first create a fork of the software project repository
from GitHub within your own GitHub account
and then obtain a local copy of that project (from your GitHub) on your machine.

1. Make sure you have a GitHub account
and that you have set up your SSH key pair for authentication with GitHub,
as explained in [Setup](../setup.html#secure-access-to-github-using-git-from-command-line).
2. Log into your GitHub account.
3. Go to the [software project template repository](https://github.com/carpentries-incubator/python-intermediate-inflammation)
3. Go to the [software project repository](https://github.com/carpentries-incubator/python-intermediate-inflammation)
in GitHub.

![Software project template repository in GitHub](../fig/template-repository.png){: .image-with-shadow width="800px" }
![Software project fork repository in GitHub](../fig/github-fork-repository.png){: .image-with-shadow width="900px" }

4. Click the `Use this template` button
towards the top right of the template repository's GitHub page to create
a **copy** of the repository under your GitHub account
(you will need to be signed into GitHub to see the `Use this template` button).
Note that each participant is creating their own copy to work on.
Also, we are not forking the directory but creating a copy
(remember - you can have only one *fork* but can have multiple *copies* of a repository in GitHub).
4. Click the `Fork` button
towards the top right of the repository's GitHub page to create
a **fork** of the repository under your GitHub account
(you will need to be signed into GitHub for the `Fork` button to work).
Note that each participant is creating their own fork to work on.
Also, we are not copying from a template but creating a fork
(remember you can have only one *fork*
but can have multiple *copies* of a repository in GitHub).
5. Make sure to select your personal account
and set the name of the project to `python-intermediate-inflammation`
(you can call it anything you like,
but it may be easier for future group exercises if everyone uses the same name).
Also set the new repository's visibility to 'Public' -
so it can be seen by others and by third-party Continuous Integration (CI) services
(to be covered later on in the course).
Ensure that you **uncheck** the `Copy the main branch only` button.
This will guarantee we get some other branches needed for later exercises,
but for the moment you can ignore them.

![Making a copy of the software project template repository in GitHub](../fig/copy-template-repository.png){: .image-with-shadow width="600px" }
![Making a fork of the software project repository in GitHub](../fig/github-fork-repository-confirm.png){: .image-with-shadow width="600px" }

6. Click the `Create repository from template` button
and wait for GitHub to import the copy of the repository under your account.
7. Locate the copied repository under your own GitHub account.
6. Click the `Create fork` button
and wait for GitHub to create the forked copy of the repository under your account.
7. Locate the forked repository under your own GitHub account.
You should be taken there automatically after confirming the fork operation,
but if not, you can click your username top left to be taken to your user page,
and then select the `Repositories` tab, where you can search for this new fork.

![View of the own copy of the software template repository in GitHub](../fig/own-template-repository.png){: .image-with-shadow width="800px" }
![View of your own fork of the software repository in GitHub](../fig/github-forked-repository-own.png){: .image-with-shadow width="900px" }

> ## Exercise: Obtain the Software Project Locally
> Using the command line, clone the copied repository
> from your GitHub account into the home directory on your computer using SSH.
> Which command(s) would you use to get a detailed list of contents of the directory you have just cloned?
> > ## Solution
> > 1. Find the SSH URL of the software project repository to clone from your GitHub account.
> > Make sure you do not clone the original template repository but rather your own copy,
> > Make sure you do not clone the original repository but rather your own fork,
> > as you should be able to push commits to it later on.
> > Also make sure you select the **SSH tab** and not the **HTTPS** one -
> > you'll be able to clone with HTTPS, but not to send your changes back to GitHub!
Expand All @@ -114,7 +117,7 @@ and then obtain a local copy of that project (from your GitHub) on your machine.
> > $ git clone git@github.com:<YOUR_GITHUB_USERNAME>/python-intermediate-inflammation.git
> > ~~~
> > {: .language-bash}
> > Make sure you are cloning your copy of the software project and not the template repository.
> > Make sure you are cloning your fork of the software project and not the original repository.
> >
> > 4. Navigate into the cloned repository folder in your command line with:
> > ~~~
Expand Down
Loading