Skip to content

Commit 049335e

Browse files
committed
markdown source builds
Auto-generated via `{sandpaper}` Source : 12b4a35 Branch : main Author : Aleksandra Nenadic <a.nenadic@manchester.ac.uk> Time : 2025-06-25 12:51:23 +0000 Message : Update and rename CITATION to CITATION.md
1 parent 433b7bf commit 049335e

5 files changed

Lines changed: 24 additions & 18 deletions

File tree

14-collaboration-using-git.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -67,26 +67,26 @@ The diagram below shows a typical software development lifecycle with Git
6767
(in our case starting from making changes in a local branch that "tracks" a remote branch) and the commonly used commands to interact
6868
with different parts of the Git infrastructure, including:
6969

70-
- **working directory** -
70+
- **working tree** -
7171
a local directory (including any subdirectories) where your project files live
7272
and where you are currently working.
73-
It is also known as the "untracked" area of Git.
74-
Any changes to files will be marked by Git in the working directory.
75-
If you make changes to the working directory and do not explicitly tell Git to save them -
73+
It is also known as the "untracked" area of Git or "working directory".
74+
Any changes to files will be marked by Git in the working tree.
75+
If you make changes to the working tree and do not explicitly tell Git to save them -
7676
you will likely lose those changes.
7777
Using `git add filename` command,
78-
you tell Git to start tracking changes to file `filename` within your working directory.
78+
you tell Git to start tracking changes to file `filename` within your working tree.
7979
- **staging area (index)** -
8080
once you tell Git to start tracking changes to files
8181
(with `git add filename` command),
8282
Git saves those changes in the staging area on your local machine.
8383
Each subsequent change to the same file needs to be followed by another `git add filename` command
8484
to tell Git to update it in the staging area.
85-
To see what is in your working directory and staging area at any moment
85+
To see what is in your working tree and staging area at any moment
8686
(i.e. what changes is Git tracking),
8787
run the command `git status`.
8888
- **local repository** -
89-
stored within the `.git` directory of your project locally,
89+
stored within the `.git` working tree of your project locally,
9090
this is where Git wraps together all your changes from the staging area
9191
and puts them using the `git commit` command.
9292
Each commit is a new, permanent snapshot (checkpoint, record) of your project in time,
@@ -106,14 +106,16 @@ with different parts of the Git infrastructure, including:
106106
is to always do a `git pull` before a `git push`, to ensure you have any latest changes before you push your own.
107107

108108
<!--
109-
Created with https://mermaid.live/edit#pako:eNqVkjFrwzAQhf-KuKmlKd01BAoZ2yUZumi5SmdbRPI58oliQv57JbuloSaFajqd3sd7x-kMlh2BhpFOmXpLO49twmh6Vc4bp6PvW7Xziaxwmh6324eDYFubz4lQq9aLQucW_fVTlb6wxaD2NPDoK77ILcfoZSF-Kyq1p8hCK2zIY7dAK8Ftr4bEdretVgPqOWBH9shZ_stFSi39EXFNfQ0WgrobO05ic4nM6Sd6uYXAH-TU-6Susz3NZvewgVJE9K7s8Fy9DUhHkQzoUjpqMAcxYPpLkWIWPky9BS0p0wby4FC-Vw66wTCWLrma-HX5F_P3uHwCS-vA3Q
109+
Created with https://mermaid.live/edit#pako:eNqVUsFOwzAM_ZXIJxBldK3aZjlMQsANLhsSEuolNF5brU1KmgjKtH8nbRlsTEPCJ9t5L-9Z9gYyJRAYtPhqUWZ4W_Jc8zqVxMWT0utS5uRRI17O5xdLw_O-vtbIGclLQ7gQI3T_qYfeq4xXZIGNakujdDfCM1XXpRkZvxE9a4G1MnhEa2xbjKQjwGmtFZqsOC21PxsbvBWYrZU1_6DUqHP8w9gB4WuSqiJnbaG0yazzqPSPV1dVlXpDQV46su_oatA5Bw9cUvNSuH1tetkUTIE1psBcKnDFbWVSSOXWQbk1atnJDJjRFj2wjeBmt15gK161rouiN_sw3sBwCh5oZfPiG9Fw-axUffjN3UDb9XLdWxpzjVKgvlFWGmDxdOAD28A7sIhGkygJ_Wjm08APp4EHHbAknszCJAoCSumUhvHWg49Bz5_QJPJdRGEYz5IkpttPWWLlPg
110+
110111
sequenceDiagram
111-
Working Directory->>+Staging Area: git add
112-
Staging Area->>+Local Repository Branch: git commit
113-
Local Repository Branch->>+Remote Repository Branch: git push
114-
Remote Repository Branch->>+Local Repository Branch: git fetch
115-
Local Repository Branch->>+Working Directory:git merge
116-
Remote Repository Branch->>+Working Directory: git pull (shortcut for git fetch followed by git merge for a 'tracking branch')
112+
Working Tree->>+Staging Area: git add
113+
Staging Area->>+Local Repository: git commit
114+
Local Repository->>+Remote Repository: git push
115+
Remote Repository->>+Local Repository: git fetch
116+
Local Repository->>+Working Tree:git checkout
117+
Local Repository->>+Working Tree:git merge
118+
Remote Repository->>+Working Tree: git pull (shortcut for git fetch followed by git checkout/merge)
117119
-->
118120

119121
<!--

41-code-review.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ on your repository (acting as a code author).
235235
2. Navigate to the pull requests tab.
236236
3. Create a new pull request by clicking the green `New pull request` button.
237237
![](fig/github-pull-request-tab.png){alt='GitHub pull requests tab' .image-with-shadow width="900px"}
238-
4. Select the base and the compare branch - `main` and `feature-std-dev`, respectively.
238+
4. Select the base and the compare branch: `develop` and `feature-std-dev`, respectively.
239239
Recall that the base branch is where you want your changes to be merged
240240
and the compare branch contains the changes.
241241
5. Click `Create pull request` button to open the request.

CITATION.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Cite as:
2+
3+
Aleksandra Nenadic, Steve Crouch, Thomas Kiley, Raniere Silva, François Michonneau, Maxim Belkin, James Graham, Greg Wilson, Matthew, Toby Hodges, Zhian N. Kamvar, Sven van der Burg, Abby Cabunoc Mayes, JacalynLaird, Sarah Stevens, Katrin Leinweber, Erin Becker, João Rodrigues, Douglas Lowe, … William L. Close. (2024). carpentries-incubator/python-intermediate-development: beta-Nov2024 (beta-Nov2024). Zenodo. https://doi.org/10.5281/zenodo.14038719

0 commit comments

Comments
 (0)