Skip to content

Commit 35d0c1a

Browse files
committed
Merge branch 'gh-pages' of github.com:swcarpentry/git-novice into update-zenodo-json
2 parents a88db0c + 5896692 commit 35d0c1a

File tree

4 files changed

+43
-27
lines changed

4 files changed

+43
-27
lines changed

_episodes/02-setup.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,15 +138,24 @@ $ git config --global init.defaultBranch main
138138
The five commands we just ran above only need to be run once: the flag `--global` tells Git
139139
to use the settings for every project, in your user account, on this computer.
140140
141-
You can check your settings at any time:
141+
Let's review those settings and test our `core.editor` right away:
142+
143+
~~~
144+
$ git config --global --edit
145+
~~~
146+
{: .language-bash}
147+
148+
Let's close the file without making any additional changes. Remember, since typos in the config file will cause
149+
issues, it's safer to view the configuration with:
142150
143151
~~~
144152
$ git config --list
145153
~~~
146154
{: .language-bash}
147155
148-
You can change your configuration as many times as you want: use the
156+
And if necessary, change your configuration using the
149157
same commands to choose another editor or update your email address.
158+
This can be done as many times as you want.
150159
151160
> ## Proxy
152161
>

_episodes/09-conflict.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,7 @@ consider these technical approaches to reducing them:
314314
- Pull from upstream more frequently, especially before starting new work
315315
- Use topic branches to segregate work, merging to main when complete
316316
- Make smaller more atomic commits
317+
- Push your work when it is done and encourage your team to do the same to reduce work in progress and, by extension, the chance of having conflicts
317318
- Where logically appropriate, break large files into smaller ones so that it is
318319
less likely that two authors will alter the same file simultaneously
319320

_episodes/10-open.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,22 @@ but the reality is often more complicated.
2121
Normal practice today looks something like this:
2222

2323
* A scientist collects some data and stores it on a machine
24-
that is occasionally backed up by her department.
25-
* She then writes or modifies a few small programs
26-
(which also reside on her machine)
24+
that is occasionally backed up by their department.
25+
* They then write or modify a few small programs
26+
(which also reside on the machine)
2727
to analyze that data.
28-
* Once she has some results,
29-
she writes them up and submits her paper.
30-
She might include her data -- a growing number of journals require this -- but
31-
she probably doesn't include her code.
28+
* Once they have some results,
29+
they write them up and submit a paper.
30+
The scientist might include their data -- a growing number of journals require this -- but
31+
they probably don't include the code.
3232
* Time passes.
33-
* The journal sends her reviews written anonymously by a handful of other people in her field.
34-
She revises her paper to satisfy them,
35-
during which time she might also modify the scripts she wrote earlier,
33+
* The journal sends the scientist reviews written anonymously by a handful of other people in their field.
34+
The scientist revises the paper to satisfy the reviewers,
35+
during which time they might also modify the scripts they wrote earlier,
3636
and resubmits.
3737
* More time passes.
3838
* The paper is eventually published.
39-
It might include a link to an online copy of her data,
39+
It might include a link to an online copy of the data,
4040
but the paper itself will be behind a paywall:
4141
only people who have personal or institutional access
4242
will be able to read it.
@@ -52,24 +52,24 @@ the process looks like this:
5252
[Digital Object Identifier](https://en.wikipedia.org/wiki/Digital_object_identifier) (DOI).
5353
Or the data was already published and is stored in
5454
[Dryad](https://datadryad.org/).
55-
* The scientist creates a new repository on GitHub to hold her work.
56-
* As she does her analysis,
57-
she pushes changes to her scripts
55+
* The scientist creates a new repository on GitHub to hold their work.
56+
* During analysis,
57+
they push changes to their scripts
5858
(and possibly some output files)
5959
to that repository.
60-
She also uses the repository for her paper;
61-
that repository is then the hub for collaboration with her colleagues.
62-
* When she's happy with the state of her paper,
63-
she posts a version to [arXiv](https://arxiv.org/)
60+
The scientist also uses the repository for their paper;
61+
that repository is then the hub for collaboration with colleagues.
62+
* When they are happy with the state of the paper,
63+
the scientist posts a version to [arXiv](https://arxiv.org/)
6464
or some other preprint server
6565
to invite feedback from peers.
6666
* Based on that feedback,
67-
she may post several revisions
68-
before finally submitting her paper to a journal.
69-
* The published paper includes links to her preprint
70-
and to her code and data repositories,
67+
they may post several revisions
68+
before finally submitting the paper to a journal.
69+
* The published paper includes links to the preprint
70+
and to the code and data repositories,
7171
which makes it much easier for other scientists
72-
to use her work as starting point for their own research.
72+
to use their work as starting point for their own research.
7373

7474
This open model accelerates discovery:
7575
the more open work is,

setup.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,15 @@ layout: page
33
title: Setup
44
---
55

6-
Please see [this section of the workshop template][workshop-setup]
7-
for instructions on installing Git.
6+
## Installing Git
7+
Since several Carpentries lessons rely on Git, please see
8+
[this section of the workshop template][workshop-setup] for
9+
instructions on installing Git for various operating systems.
10+
- [Git installation on Windows][workshop-setup]
11+
- [Git installation on MacOS][workshop-setup]
12+
- [Git installation on Linux][workshop-setup]
813

14+
## Preparing Your Working Directory
915
We'll do our work in the `Desktop` folder so make sure you change your working directory to it with:
1016

1117
~~~

0 commit comments

Comments
 (0)