Skip to content

Commit 04d8fd9

Browse files
committed
final check of q&a doc, some grammar/clarification
1 parent 7d0e9c2 commit 04d8fd9

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

Q_and_A.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,38 +5,39 @@
55
**Have you used the same process (Git/GitHub) for manuscripts? If so, any tips or suggestions?**
66

77
Git and GitHub work best with raw text files. Code is an example of this, and allows for the line-by-line
8-
changes we saw in the tutorial. If you use LaTeX to write manuscripts, Git/GitHub would be a great option
8+
tracked changes we saw in the tutorial. If you use LaTeX to write manuscripts, Git/GitHub would be a great option
99
for manuscript version control. But if you use Word Documents, there are probably better options because
10-
they are not raw text files. Here are two to consider:
10+
they are not raw text files. Here are two options to consider:
1111
1. Google Drive has some [version control functionality](https://support.google.com/drive/answer/2409045?co=GENIE.Platform%3DDesktop&hl=en)
1212
with any type of file. It is limited, but can be very useful still.
13-
2. Services like [Simul Docs](https://www.simuldocs.com/how-it-works) provide version control for Word
13+
2. A service like [Simul Docs](https://www.simuldocs.com/how-it-works) provides version control for Word
1414
Documents specifically. At this time, it is free to collaborate on a single document, but they offer paid
15-
services for more functionality. I'm using it for one of my manuscripts and it's based on the same version
15+
services for more functionality. I'm using Simul Docs for one of my manuscripts and it's based on the same version
1616
control concepts we introduced at the start of this tutorial.
1717

1818
**When do I create a new repository?**
1919

20-
Repositories contain files for a give project, so I would have a repository for each project or study you have.
21-
You can then organize your repo with subfolders for scripts used to process, analyze, or visualize your data.
20+
Repositories contain files for a given project, so I would have a repository for each project or study you might have.
21+
You can then organize your repo with subfolders for scripts used to process, analyze, or visualize your data, for example.
2222

2323
**If I have multiple files in a repository and I think I may need to edit only some of them, should I
2424
just branch/checkout those files or all of them?**
2525

26-
A clear distinction we need to make is that when you branch out, your entire repository is copied. This will
26+
A clear distinction we need to make is that when you checkout a branch, your entire repository is copied. This will
2727
contain all of your files, so you don't need to worry about knowing ahead of time which files you'll need
28-
to change. You can just make changes, committing them along the way, to the files you'd like to change.
28+
to change. You can just make changes in a branch, committing them along the way.
2929
When you are satisfied with the changes you've made in your branch, you can merge them into the master
3030
branch via a Pull Request like you did during [`Breakout 1`](Tutorial_Instructions/breakout_1.md).
3131

3232
**How does Git handle reverting back to an earlier version (from version n to n-2, for example)?
3333
What happens to versions n and n-1?**
3434

35-
The way that undoing changes is handled in [`Breakout 2`](Tutorial_Instructions/breakout_2.md) is in a way
36-
that *maintains the integrity of your repository history*. That is to say that what is happening when we say
37-
your repository is "reverted" is that a new commit is being made that undoes the prior changes. The changes you
38-
made in version n and n-1 are still present in your repository's commit history. However, version n+1 now
39-
contains changes that are the opposite of versions n and n-1. This is illustrated in the
35+
We didn't have time to cover this in the 2020 ASB Tutorial, but it's been included in the associated video on youtube.
36+
Undoing changes is handled by [`Breakout 2`](Tutorial_Instructions/breakout_2.md) in a way
37+
that *maintains the integrity of your repository history*. This means that when we say
38+
your repository is "reverted", a new commit is being made that undoes the prior changes. The changes you
39+
made in version n and n-1 are still present in your repository's commit history in case you ever want to view them.
40+
However, version n+1 now contains changes that are the exact opposite of versions n and n-1. This is illustrated in the
4041
[Further Considerations](https://github.com/alcantarar/ASB_Tutorial/blob/master/Tutorial_Instructions/breakout_2.md#further-considerations-reverting-multiple-changes-at-once)
4142
portion of Breakout 2.
4243

0 commit comments

Comments
 (0)