Skip to content

Commit 306b2d9

Browse files
committed
Added source control primer to documentation
1 parent 18dafa9 commit 306b2d9

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@
3434
3535
## Basic Use
3636
37+
### Source Control
38+
39+
For this with less experience using source control, we recommend this [page](/docs/scintro.md) for a quick introduction to source control / change control basics.
40+
3741
### Health Connect Cloud (HCC)
3842
git-source control is the recommended source control for HCC. [This page](/docs/hcc.md) covers HCC specific usage of git-source-control, including the recommended development workflow, initial setup, and CICD pipelining.
3943

docs/scintro.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# A Brief Introduction to Source Control
2+
3+
Source control, or change control, is a system that helps teams manage and track changes to their work, with particulaar relevancy to software development. It helps produce a definitive record of the hostory of the product, as well as allow for revisiting earlier versions and previous changes. This means that multiple people can work on the same thing together without getting in each other's way. You can see who made changes, when they were made, and what these changes were addressing. If any change leads to issues, this allows teams to quickly roll back to a previous version that is working, as well as identify which specific change may have caused the issue.
4+
5+
## Key Concepts
6+
7+
### Versioning
8+
9+
Each change or batch of changes is saved as a new version. This allows users and developers to reference or revert to previous versions when necessary (git-source-control is itself versioned)
10+
11+
### History Tracking
12+
13+
Since every change is logged, source control provides users with a complete history of a project, allowing anyone to track its evolution, as well as pinpoint causes and the nature of issues that may arise
14+
15+
### Branching
16+
17+
Branching involves creating distinct copies of the same product, so that changes can be made and tested in isolation, without affecting other users and changes. These "branches" can be merged to bring changes back to the main product.
18+
19+
20+
### Example of source control
21+
22+
A teammate and I are working on an article. I am focusing on the introduction and conclusion, while they focus on the main paragraph. To avoid conflicts, we create seperate copies (branches) of the article to work on. When I am finished with my work, I can merge the changes I have made back into the main article. Others can see the exact changes I have made, and if anyone else is working on the same section we won't run into problems because I have my own separate copy.

0 commit comments

Comments
 (0)