Skip to content

Commit 7ccaa11

Browse files
committed
Minor changes - grammar, highlighted text naming buttons. Added sub-points on Why use version control section.
1 parent 75ce174 commit 7ccaa11

File tree

1 file changed

+26
-22
lines changed

1 file changed

+26
-22
lines changed

version-control/introduction/tutorial.md

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Introduction to version control and git
55

66
## What is version control?
77

8-
Version control is a way to manage and track any changes you make to your files.
8+
Version control is a way to manage and track any changes you make to your files. If you've been using online services such as Google Docs or Wikipedia, then you'll already have been working with documents and pages that use a version control system.
99

1010
### Google docs revision history
1111

@@ -38,21 +38,23 @@ Wikipedia also holds a history of all changes.
3838

3939
## Why do you need Version Control?
4040

41-
- When used on a regular basis, version control helps you to store your files safely. It makes it easy to figure out what broke your code as you can roll back to a previous version and work out when things last worked as expected.
41+
- When used on a regular basis, version control helps you to store your files safely. It makes it easy to figure out what broke your code, as you can roll back to a previous version and work out when things last worked as expected.
42+
- With no version control in place you'll only have one copy of your file, then when it breaks there's no way to get back to good code!
4243

43-
- It is also helpful when working with other people as it combines all the changes together, and tracks who, why and when it changed.
44+
- It is also helpful when working with other people as it combines all the changes together and tracks who, why and when it changed.
45+
- In the work environment this may be essential to know for example, what issue the change fixes or customer requirement it relates to.
4446

4547
## Code version control systems
4648

47-
There are a number of different version control systems. The most popular ones are **svn** (or Subversion), **cvs**, **mercurial** and **git**.
49+
There are a number of different version control systems. The most popular ones are **svn** (or Subversion), **cvs**, **Mercurial** and **Git**.
4850

49-
We will be using **git**.
51+
We will be using **Git**.
5052

5153
### Why Git?
5254

53-
There are a number of reasons we chose git. To name some
55+
There are a number of reasons we chose Git, namely;
5456

55-
- A lot of learning resources
57+
- A lot of learning resources are publicly available
5658

5759
- Does not require you to be connected to the internet to use
5860

@@ -62,7 +64,7 @@ There are a number of reasons we chose git. To name some
6264

6365
- Github and online collaboration. Open source code is a big part of today's life. By being able to retrieve and help existing projects, you can also contribute to them
6466

65-
Some popular project using git:
67+
Some popular projects using Git:
6668

6769
- Android
6870

@@ -78,23 +80,25 @@ Some popular project using git:
7880

7981
## Terminology
8082

81-
- repository: A repository is where code is stored
83+
As with any technology and related tool, there's a lot of terminollgy used. Here's some of the most common terms and their definitions:
8284

83-
- checkout: When you retrieve code from a **repository**
85+
- **Repository**: A repository is where code is stored
8486

85-
- commit: Applying any changes you have made to the **repository**
87+
- **Checkout**: When you retrieve code from a **repository**, to you local machine
88+
89+
- **Commit**: Applying any changes you have made to the **repository**
8690

8791
#### Aim for small and focused changes
8892

89-
When using version control, you should commit every time you do a small piece of work, rather than working for hours in a row, changing too many things and then committing them.
93+
When using version control, you should commit every time you do a small piece of work, rather than working for hours in a row, changing too many things and then committing them is a great way to introduce issues that are hard to track down.
9094

91-
For example, if you want to change the position of an element, the color of all the links on your page and the font size dimensions of all paragraphs, you should do three commits, using messages that describe what you are doing each time.
95+
For example, if you want to change the position of an element, the colour of all the links on your page and the font size dimensions of all paragraphs, you should do three commits, using messages that describe what you are doing each time.
9296

93-
### Bad commit messages
97+
### Write meaningful commit messages
9498

95-
Every time you commit a change use a message that describes your change clearly. In a few months time you will have difficulty remembering why you applied a change if your messages say _changing some CSS_, _another commit_, or _more changes_
99+
Every time you commit a change use a message that describes your change clearly. In a few months time you will have difficulty remembering why you applied a change if your messages say _changing some CSS_, _another commit_ or _more changes_
96100

97-
Try using messages like _repositioned image to look better on page_, _resolved positioning issue for Firefox_.
101+
Try using messages such as _repositioned image to look better on page_ or _resolved positioning issue for Firefox_.
98102

99103
# The next step!
100104

@@ -104,17 +108,17 @@ Download [Github Desktop](https://desktop.github.com/) (for Mac or Windows).
104108

105109
## Now what?
106110

107-
Now that you have the Github client setup on your machine, we will spend some time adding what you have created in the HTML & CSS lessons on the internet! Before you start make sure the Github client is running and you are signed in.
111+
Now that you have the Github client setup on your machine, we will spend some time adding what you have created in the HTML & CSS lessons to an internet repository! Before you start make sure the Github client is running and you are signed in.
108112

109-
1. Create a new repository by clicking the Create New Repository button
113+
1. Create a new repository by clicking the `Create New Repository` button
110114

111115
![](images/create-new-repository.png)
112116

113-
2. Open the directory you just created in your text editor and create a README.md file with the following content:
117+
2. In your text editor, open the directory you just created and create a README.md file with the following content:
114118

115119
_This is where I store the work I have done at codebar._
116120

117-
3. Go back to the Github client and commit the file by filling out the Summary field and hitting the Commit to master button
121+
3. Go back to the Github client and commit the file by filling out the `Summary` field and hitting the `Commit to master` button
118122

119123
![](images/add-readme.png)
120124

@@ -135,11 +139,11 @@ Now that you have the Github client setup on your machine, we will spend some ti
135139

136140
![](images/commit-changes.png)
137141

138-
8. Once you committed your changes publish your work by clicking the **Publish repository** button
142+
8. Once you committed your changes publish your work by clicking the `Publish repository` button
139143

140144
![](images/publish-repository.png)
141145

142-
9. View your work on the internet!
146+
9. View your work on the web!
143147

144148
To access your work, go to `http://<username>.github.io/codebar`
145149

0 commit comments

Comments
 (0)