From 124475371e303046bac3a031016a787cd4f826e6 Mon Sep 17 00:00:00 2001 From: Jonah Duckles Date: Thu, 10 May 2018 13:23:48 +1200 Subject: [PATCH 1/2] Explain version control before Git The lesson as is jumps right into Git without motivating VC. Tried to give a bit of background and overview on the motivation for Version Control and what the term means. --- _episodes/01-what-is-git.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/_episodes/01-what-is-git.md b/_episodes/01-what-is-git.md index 4577588c..c2364622 100644 --- a/_episodes/01-what-is-git.md +++ b/_episodes/01-what-is-git.md @@ -11,6 +11,23 @@ objectives: keypoints: - "Git and Github are not the same" --- + +### What is Version Control + +Version control is a name used for software which can help you record changes you make to the files in a directory on your computer. Version control software and tools (such as Git and Subversion/SVN) are often associated with software development. Increasingly though they can are being used for all kinds of files across research and academic collaborations. It is most useful when working with plain text files such as documents or computer code, but modern version control systems can be used to track changes in any type of file. + +At its most basic level, version control software helps us register and track sets of changes made to files on our computer. We can then reason about and share those changes with others. As we build up sets of changes over time, we begin to see some benefits. + +#### Benefits of using version control? + +* **Collaboration** - Version control allows us to define formalized ways we can work together and share writing and code. For example merging together sets of changes from different parties enables co-creation of documents and software across distributed teams. +* **Versioning** - Having a robust and rigourous log of changes to a file, without renaming files (v1, v2, _final_copy) +* **Rolling Back** - Version control allows us to quickly undo a set of changes. This can be useful when new writing or code introduces a problem elsewhere. +* **Understanding** - Version control can help you understand how the code or writing came to be, who wrote or contributed particular parts and who you might ask to help understand it better. +* **Backup** - While not meant to be a backup solution, using version control systems mean that your code and writing can be on multiple other computers. + +There are many more reasons to use version control, and we'll explore some of these in the Library context, but first lets learn a bit about a popular version control tool called Git. + ### What is Git and GitHub? We often hear the terms **_Git_** and **_GitHub_** used interchangeably but they are slightly different things. From d17dff3cd7dc0ba982193a42ba7d1fe7ffbf7ed4 Mon Sep 17 00:00:00 2001 From: Belinda Weaver Date: Thu, 10 May 2018 11:45:17 +1000 Subject: [PATCH 2/2] Update 01-what-is-git.md fixing a few typos --- _episodes/01-what-is-git.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/_episodes/01-what-is-git.md b/_episodes/01-what-is-git.md index c2364622..2cc48ba2 100644 --- a/_episodes/01-what-is-git.md +++ b/_episodes/01-what-is-git.md @@ -14,19 +14,19 @@ keypoints: ### What is Version Control -Version control is a name used for software which can help you record changes you make to the files in a directory on your computer. Version control software and tools (such as Git and Subversion/SVN) are often associated with software development. Increasingly though they can are being used for all kinds of files across research and academic collaborations. It is most useful when working with plain text files such as documents or computer code, but modern version control systems can be used to track changes in any type of file. +Version control is a name used for software which can help you record changes you make to the files in a directory on your computer. Version control software and tools (such as Git and Subversion/SVN) are often associated with software development. Increasingly though they can are being used for all kinds of files across research and academic collaborations. Version control systems work best with plain text files such as documents or computer code, but modern version control systems can be used to track changes in any type of file. At its most basic level, version control software helps us register and track sets of changes made to files on our computer. We can then reason about and share those changes with others. As we build up sets of changes over time, we begin to see some benefits. #### Benefits of using version control? * **Collaboration** - Version control allows us to define formalized ways we can work together and share writing and code. For example merging together sets of changes from different parties enables co-creation of documents and software across distributed teams. -* **Versioning** - Having a robust and rigourous log of changes to a file, without renaming files (v1, v2, _final_copy) -* **Rolling Back** - Version control allows us to quickly undo a set of changes. This can be useful when new writing or code introduces a problem elsewhere. -* **Understanding** - Version control can help you understand how the code or writing came to be, who wrote or contributed particular parts and who you might ask to help understand it better. -* **Backup** - While not meant to be a backup solution, using version control systems mean that your code and writing can be on multiple other computers. +* **Versioning** - Having a robust and rigorous log of changes to a file, without renaming files (v1, v2, _final_copy_) +* **Rolling Back** - Version control allows us to quickly undo a set of changes. This can be useful when new writing or new additions to code introduce problems. +* **Understanding** - Version control can help you understand how the code or writing came to be, who wrote or contributed particular parts, and who you might ask to help understand it better. +* **Backup** - While not meant to be a backup solution, using version control systems mean that your code and writing can be stored on multiple other computers. -There are many more reasons to use version control, and we'll explore some of these in the Library context, but first lets learn a bit about a popular version control tool called Git. +There are many more reasons to use version control, and we'll explore some of these in the library context, but first let's learn a bit about a popular version control tool called Git. ### What is Git and GitHub?