Skip to content

Commit 93ac5f8

Browse files
committed
test line breaks
1 parent bc4589a commit 93ac5f8

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

workshop/01-why-github.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,21 @@ title: Why Github?
77

88
Fundamentally, Github helps implement version control. That is to say: it helps to save, organize, and share different versions of a research project.
99

10+
<br>
1011
### Version History
1112
In scientific fields, it is important to document and justify the steps you take in an analysis. Creating a version history facilitates this process by documenting the changes you make to a project and the reason for making them. Whether you are writing the methods section for a paper or returning to an old project years later, a version history ensures that you know exactly what is happening in your analysis.
1213

1314
Furthermore, a version history makes it easy to restore previous versions of a project. For example, if you make changes that break your code, you can easily return to a working version. Similarly, if you try out a new analysis and decide it's not actually useful, you can quickly return to a version of the project without the analysis.
1415

16+
<br>
1517
### Back up files
1618
Given the time and effort that goes into research, it's terrible to lose your work. By saving and backing up versions of a project, you can ensure that your work is never lost, even if a computer is destroyed or files are accidentally deleted. (Quick note: Github limits file sizes to 100MB, so it's mostly meant to back up code and small files. If you need to back up and version control large datasets, you should look into other platforms.)
1719

20+
<br>
1821
### Organize simultaneous versions of a file
1922
Sometimes it can be useful to use multiple versions of a file simultaneously. For example, you may have a common analysis script that uses different settings for different papers. Managing the different versions of this file is important, as you would not want to apply the wrong settings to an analysis. Github provides a framework to organize such files.
2023

24+
<br>
2125
### Share versions with collaborators
2226
When working with collaborators, it's not uncommon to share some code, make changes to the code, but forget to re-share the updated file. Alternatively, you may want to design code collaboratively, but lack a platform to do so. By backing up files to cloud, Github ensures that collaborators always have access to the most up-to-date version of code.
2327

0 commit comments

Comments
 (0)