Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
b2021ec
move command line git merge to 4.1
rogerkuou Nov 12, 2025
a5b6226
move tagging to 4.3
rogerkuou Nov 12, 2025
9e3a897
consider develop branch
rogerkuou Nov 12, 2025
23b7496
skeleton on mkdocs
rogerkuou Nov 12, 2025
a1c3a48
mkdocs descriptions
rogerkuou Nov 12, 2025
0dd84af
update documentation aux description
rogerkuou Nov 12, 2025
6d7a091
pyproject.toml
rogerkuou Nov 12, 2025
3a5c312
imporve wording
rogerkuou Nov 12, 2025
50432ab
update title of 4.2
rogerkuou Nov 12, 2025
cafeb8e
update tagging
rogerkuou Nov 12, 2025
5ad248f
change from Poetry to uv
rogerkuou Nov 12, 2025
751a2e6
update branch description
rogerkuou Nov 13, 2025
8111a7b
explain language dependencies
rogerkuou Nov 13, 2025
df7433e
Apply suggestions from code review
rogerkuou Nov 13, 2025
a325889
update licese exercise
rogerkuou Nov 13, 2025
354abec
add screenshots for rendered citation files
rogerkuou Nov 13, 2025
5bfe2af
add screenshots for gh-pages settings
rogerkuou Nov 13, 2025
62cd811
update screenshots
rogerkuou Nov 14, 2025
c78b7ad
Update episodes/42-software-reuse.md
rogerkuou Nov 14, 2025
b50eafb
Apply suggestions from code review
rogerkuou Nov 17, 2025
b1f1e92
Apply suggestions from code review
rogerkuou Nov 17, 2025
0163606
move dependency editing of toml file to 4.3 with uv
rogerkuou Nov 17, 2025
b8347eb
gh actions for mkdocs
rogerkuou Nov 17, 2025
9340727
add a callout session for Python Packaging Guide
rogerkuou Nov 17, 2025
467d819
add a callout session for Python Packaging User Guide
rogerkuou Nov 17, 2025
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
21 changes: 21 additions & 0 deletions episodes/41-code-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -567,6 +567,27 @@ This tells the author you are happy for them to merge the pull request.
![](fig/github-merge-pull-request.png){alt='Merging a pull request in GitHub' .image-with-shadow width="800px"}
2. Delete the merged branch to reduce the clutter in the repository.

::: callout

### Merge via command line

The `git merge` command provides a way to directly merge branches on your local. In general, when adding changes to the major branches like `develop` or `main`, this is not a good practice since it bypasses the code review process. It is a common practice for an open-source project to protect its most important branches, meaning pushing directly to one of these branches will fail. Therefore, even if you can merge to `develop` or `main` locally, you will not be able to push the changes to the remote repository.

On the other hand, the `git merge` command can be very useful for keeping your feature branch up to date with the major branches. For example, if you are working on a branch `my-feature` and the `develop` branch has received new commits (e.g. someone else has merged their pull request), you can do the following to include changes from `develop` into your feature branch:

```bash
# First update your local develop branch
$ git checkout develop
$ git pull develop
# Then switch back to your feature branch and merge the latest develop into it
$ git checkout my-feature
$ git merge develop
```

In this way, you can keep your feature branch up to date. You may need to resolve conflicts that arise during this process.

:::

## Writing Easy-To-Review Code

There are a few things you can do to make it
Expand Down
Loading
Loading