Skip to content

Commit 1a2c732

Browse files
committed
1 parent 4deedc1 commit 1a2c732

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+135
-135
lines changed

Diff for: docs/01_getting_ready_for_class.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
## Getting Ready for Class
1+
## Getting ready for class
22

33
While you are waiting for class to begin, please take a few minutes to set up your local work environment.
44

55
<!-- toc -->
66

7-
### Step 1: Set Up Your GitHub.com Account
7+
### Step 1: Set up your GitHub.com account
88

99
For this class, we will use a public account on GitHub.com. We do this for a few reasons:
1010

@@ -43,13 +43,13 @@ In general, we recommend you stay within two minor versions of the [latest versi
4343

4444
We suggest having version [2.29.2](https://github.com/git-for-windows/git/releases/tag/v2.29.2.windows.2) or more recent if you're using Git for Windows or Git Bash.
4545

46-
#### Downloading and Installing Git
46+
#### Downloading and installing Git
4747

4848
If you don't already have Git installed, you can download Git at www.git-scm.com.
4949

5050
If you need additional assistance installing Git, you can find more information in [the ProGit chapter on installing Git](http://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
5151

52-
#### Where is Your Shell?
52+
#### Where is your shell?
5353

5454
Now is a good time to create a shortcut to the command line application you will want to use with Git:
5555

@@ -97,11 +97,11 @@ git config --global http.proxy https://YOUR_PROXY_USERNAME:YOUR_PROXY_PASSWORD@Y
9797

9898
Replace `YOUR_PROXY_USERNAME` with the username used to authenticate into your proxy, `YOUR_PROXY_PASSWORD` with the password used to authenticate into your proxy, and `YOUR.PROXY.SERVER` with your proxy's URL.
9999

100-
### Step 4: Set Up Your Text Editor
100+
### Step 4: Set up your text editor
101101

102102
For this class, we will use a basic text editor to interact with our code. Let's make sure you have one installed and ready to work from the command line.
103103

104-
#### Pick Your Editor
104+
#### Pick your editor
105105

106106
You can use almost any text editor, but we have the best success with the following:
107107

@@ -115,7 +115,7 @@ You can use almost any text editor, but we have the best success with the follow
115115

116116
If you do not already have a text editor installed, go ahead and download and install one of the above editors now! You can also configure Atom as your default text editor for Git commands using the [instructions at docs.github.com](https://docs.github.com/github/using-git/associating-text-editors-with-git).
117117

118-
#### Your Editor on the Command Line
118+
#### Your editor on the command line
119119

120120
After you have installed an editor, confirm you can open it from the command line.
121121

Diff for: docs/02_getting_started.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Getting Started With Collaboration
1+
## Getting started with collaboration
22

33
We will start by introducing you to Git, GitHub, and the collaboration features we will use throughout the class. Even if you have used GitHub in the past, we hope this information will provide a baseline understanding of how to use it to build better software!
44

@@ -25,7 +25,7 @@ In addition to being a place to host and share your Git projects, GitHub provide
2525

2626
![GitHub Collaboration Features](./img/collaboration-features.png)
2727

28-
### The GitHub Ecosystem
28+
### The GitHub ecosystem
2929

3030
Rather than force you into a "one size fits all" ecosystem, GitHub strives to be the place that brings all of your favorite tools together. For more information on integrations, check out <https://github.com/integrations>.
3131

@@ -48,45 +48,45 @@ As we begin to discuss Git (and what makes it special) it would be helpful if yo
4848

4949
We will learn more about how Git stores your code as we go through this class, but the first thing you will need to understand is how Git works with your content.
5050

51-
#### Snapshots, not Deltas
51+
#### Snapshots, not deltas
5252

5353
One of the first ideas you will need understand is that Git does not store your information as series of changes. Instead Git takes a snapshot of your repository at a given point in time. This snapshot is called a commit.
5454

55-
#### Optimized for Local Operations
55+
#### Optimized for local operations
5656

5757
Git is optimized for local operation. When you clone a copy of a repository to your local machine, you receive a copy of the entire repository and its history. This means you can work on the plane, on the train, or anywhere else your adventures find you!
5858

59-
#### Branches are Lightweight and Cheap
59+
#### Branches are lightweight and cheap
6060

6161
Branches are an essential concept in Git.
6262

6363
When you create a new branch in Git, you are actually just creating a pointer that corresponds to the most recent commit in a line of work. Git keeps the commits for each branch separate until you explicitly tell it to merge those commits into the main line of work.
6464

65-
#### Git is Explicit
65+
#### Git is explicit
6666

6767
Which brings us to our final point for now; Git is very explicit. It does not do anything until you tell it to. No auto-saves or auto-syncing with the remote, Git waits for you to tell it when to take a snapshot and when to send that snapshot to the remote.
6868

69-
### Exploring a GitHub Repository
69+
### Exploring a GitHub repository
7070

7171
A repository is the most basic element of GitHub. It is easiest to imagine as a project's folder. However, unlike an ordinary folder on your laptop, a GitHub repository offers simple yet powerful tools for collaborating with others.
7272

7373
A repository contains all of the project files (including documentation), and stores each file's revision history. Whether you are just curious or you are a major contributor, knowing your way around a repository is essential!
7474

7575
![GitHub Repositories](./img/repository-intro.png)
7676

77-
### User Accounts vs. Organization Accounts
77+
### User accounts vs. organization accounts
7878

7979
There are two account types in GitHub, user accounts and organization accounts. While there are many differences in these account types, one of the more notable differences is how you handle permissions.
8080

81-
#### User Accounts
81+
#### User accounts
8282

8383
When you signed up for GitHub, you were automatically given a user account. Permissions for a user account are simple, you add people as collaborators to specific repositories to give them full read-write access to the project.
8484

85-
#### Organization Accounts
85+
#### Organization accounts
8686

8787
Organization accounts provide more granular control over repository permissions. In an organization account you create teams of people and then give those teams access to specific repositories. Permissions can be assigned at the team level (e.g, read, write, or admin).
8888

89-
### Repository Navigation
89+
### Repository navigation
9090

9191
#### Code
9292

@@ -135,7 +135,7 @@ In GitHub, you will use issues to record and discuss ideas, enhancements, tasks,
135135

136136
GitHub uses a syntax called **Markdown** to help you add basic text formatting to Issues, Pull Requests, and files with the `.md` extension.
137137

138-
### Commonly Used Markdown Syntax
138+
### Commonly used Markdown syntax
139139

140140
#### `# Header`
141141

Diff for: docs/02a_activity_create_github_issue.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Activity: Creating A GitHub Issue
1+
### Activity: Creating a GitHub issue
22

33
Follow these steps to create an issue in the class repository:
44

Diff for: docs/03_github_flow.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
In this section, we discuss the collaborative workflow enabled by GitHub.
44

5-
### The Essential GitHub Workflow
5+
### The essential GitHub workflow
66

77
![GitHub Workflow](./img/github-workflow.png)
88

Diff for: docs/04_branching_with_git.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The first step in the GitHub Workflow is to create a branch. This will allow us to experiment with new features without accidentally introducing untested changes on our production branch.
44

5-
### Branching Defined
5+
### Branching defined
66

77
![GitHub Workflow](./img/github-workflow.png)
88

Diff for: docs/04a_activity_create_branch.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Activity: Creating A Branch with GitHub
1+
### Activity: Creating a branch with GitHub
22

33
Earlier you created an issue about the file you would like to edit. Let's create the branch you will use to edit your file.
44

Diff for: docs/05_local_git_configs.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## Local Git Configuration
1+
## Local Git configuration
22

33
In this section, we will prepare your local environment to work with Git.
44

5-
### Checking Your Git Version
5+
### Checking your Git version
66

77
First, let's confirm your [Git Installation](https://git-scm.com/downloads):
88

@@ -16,7 +16,7 @@ If you do not see a Git version listed or this command returns an error, you may
1616

1717
> To get the latest version of Git, visit [www.git-scm.com](https://www.git-scm.com).
1818
19-
### Git Configuration Levels
19+
### Git configuration levels
2020

2121
![Git Configuration Levels](./img/config-levels.png)
2222

@@ -36,7 +36,7 @@ These are the repository level configurations. They only apply to the specific r
3636

3737
> The default value for git config is `--local`.
3838
39-
### Viewing Your Configurations
39+
### Viewing your configurations
4040

4141
If you would like to see which config settings have been added automatically, you can type `git config --list`. This will automatically read from each of the three config files and list the setting they contain.
4242

@@ -50,7 +50,7 @@ You can also narrow the list to a specific configuration level by including it b
5050
git config --global --list
5151
```
5252

53-
### Configuring Your User Name and Email
53+
### Configuring your name and email address
5454

5555
Git uses the config settings for your user name and email address to generate a unique fingerprint for each of the commits you create. You can't create commits without these settings:
5656

@@ -59,14 +59,14 @@ git config --global user.name "First-name Surname"
5959
git config --global user.email "[email protected]"
6060
```
6161

62-
Example:
62+
**Example:**
6363

6464
```sh
6565
git config --global user.name "Mona Octocat"
6666
git config --global user.email "[email protected]"
6767
```
6868

69-
#### Git Config and Your Privacy
69+
#### Git config and your privacy
7070

7171
The instructions for this exercise use the `--global` flag when identifying your `user.name` and `user.email` configuration settings. If you are currently using a computer without a private, personal account, don't apply the `--global` flag. This way, the settings will only be stored in our assignment repository. If you work in another repository on this same computer, you will need to set these configuration options again.
7272

Diff for: docs/06_working_locally.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## Working Locally with Git
1+
## Working locally with Git
22

33
Using the command line, you can easily integrate Git into your current workflow.
44

5-
### Creating a Local Copy of the repo
5+
### Creating a local copy of the repo
66

77
![Cloning a repository](./img/clone-diagram.png)
88

@@ -19,7 +19,7 @@ Let's go ahead and clone the class repository to your local desktop.
1919
1. Retrieve a full copy of the repository from GitHub: `git clone <CLONE-URL>`
2020
1. Once the clone is complete, cd into the new directory created by the clone operation: `cd <REPOSITORY-NAME>`
2121

22-
### Our Favorite Git command: `git status`
22+
### Our favorite Git command: `git status`
2323

2424
```shell-session
2525
$ git status
@@ -30,7 +30,7 @@ nothing to commit, working tree clean
3030

3131
`git status` is a command you will use often to verify the current state of your repository and the files it contains. Right now, we can see that we are on branch main, everything is up to date with origin/main and our working tree is clean.
3232

33-
### Using Branches locally
33+
### Using branches locally
3434

3535
```sh
3636
git branch
@@ -47,7 +47,7 @@ If you want to see all of the branches, including the read-only copies of your r
4747

4848
> The `--all` and `-a` are actually synonyms for the branch command. Git often provides a verbose and a short option.
4949
50-
### Switching Branches
50+
### Switching branches
5151

5252
```sh
5353
git switch <BRANCH-NAME>
@@ -59,7 +59,7 @@ To switch the branch you created online, type `git switch` and the name of your
5959
6060
[include](06a_activity_create_file.md ':include')
6161

62-
### The Two Stage Commit
62+
### The two stage commit
6363

6464
After you have created your file, it is time to create your first snapshot of the repository. When working from the command line, you will need to be familiar with the idea of the two stage commit.
6565

Diff for: docs/07_collaborating_on_code.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## Collaborating on Your Code
1+
## Collaborating on your code
22

33
Now that you have made some changes in the project locally, let's learn how to push your changes back to the shared class repository for collaboration.
44

5-
### Pushing Your Changes to GitHub
5+
### Pushing your changes to GitHub
66

77
![Pushing to GitHub](./img/push-pull.png)
88

@@ -21,7 +21,7 @@ git push
2121

2222
[include](07a_activity_create_pull_request.md ':include')
2323

24-
### Exploring a Pull Request
24+
### Exploring a pull request
2525

2626
Now that we have created a Pull Request, let's explore a few of the features that make Pull Requests the center of collaboration:
2727

@@ -37,23 +37,23 @@ The **Commits** tab contains more detailed information about who has made change
3737

3838
The **Files changed** tab allows you to see cumulative effect of all the changes made on the branch. We call this the `diff`. Our diff isn't very interesting yet, but as we make changes your diff will become very colorful.
3939

40-
### Code Review in Pull Requests
40+
### Code review in pull requests
4141

4242
To provide feedback on proposed changes, GitHub offers three levels of commenting:
4343

44-
#### General Conversation
44+
#### General conversation
4545

4646
You can provide general comments on the Pull Request within the **Conversation** tab.
4747

48-
#### Line Comments
48+
#### Line comments
4949

5050
In the **Files changed** tab, you can hover over a line to see a blue ![`+`][octicon-diff-added] icon. Clicking this icon will allow you to enter a comment on a specific line. These line level comments are a great way to give additional context on recommended changes. They will also be displayed in the **Conversation** tab.
5151

5252
#### Review
5353

5454
When you are making line comments, you can also choose to **Start a Review**. When you create a review, you can group many line comments together with a general message: Comments, Approve, or Request Changes. Reviews have special power in GitHub when used in conjunction with protected branches.
5555

56-
### Activity: Code Review
56+
### Activity: Code review
5757

5858
One of the best ways to ensure code quality is to make peer reviews a part of every Pull Request. Let's review your partner's code now:
5959

Diff for: docs/07a_activity_create_pull_request.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Activity: Creating a Pull Request
1+
### Activity: Creating a pull request
22

33
Pull Requests are used to propose changes to the project files. A pull request introduces an action that addresses an Issue. A Pull Request is considered a "work in progress" until it is merged into the project.
44

Diff for: docs/08_edit_on_github.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
## Editing Files on GitHub
1+
## Editing files on GitHub
22

33
Since you created the pull request, you will be notified when someone adds a comment or a review. Sometimes, the reviewer will ask you to make a change to the file you just created. Let's see how GitHub makes this easy.
44

5-
### Editing a File on GitHub
5+
### Editing a file on GitHub
66

77
To edit a pull request file, you will need to access the **Files changed** tab.
88

99
1. Click ![octicon-kebab-horizontal] in the top right corner of the diff.
1010
1. Click **Edit file** to edit the file using the GitHub file editor.
1111
1. Make changes to the file based on the comments from your reviewer or your personal perspective.
1212

13-
### Committing Changes on GitHub
13+
### Committing changes on GitHub
1414

1515
Once you have made some changes to your file, you will need to create a new commit.
1616

@@ -19,7 +19,7 @@ Once you have made some changes to your file, you will need to create a new comm
1919
1. Choose the option to **Commit directly to your branch**.
2020
1. Click **Commit changes**.
2121

22-
### Activity: Editing Files in Pull Requests
22+
### Activity: Editing files in pull requests
2323

2424
Go back to your Pull Request and make the edits requested by your collaborators.
2525

Diff for: docs/09_merging_pull_requests.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## Merging Pull Requests
1+
## Merging pull requests
22

33
Now that you have made the requested changes, your pull request should be ready to merge.
44

5-
### Merge Explained
5+
### Merge explained
66

77
When you merge your branch, you are taking the content and history from your feature branch and adding it to the content and history of the `main` branch.
88

@@ -16,7 +16,7 @@ Many project teams have established rules about who should merge a pull request.
1616

1717
This is a discussion you should have with the other members of your team.
1818

19-
### Merging Your Pull Request
19+
### Merging your pull request
2020

2121
Let's take a look at how you can merge the pull request.
2222

@@ -33,7 +33,7 @@ Let's take a look at how you can merge the pull request.
3333
- **Squash and merge:** This option will take all of the commits on your branch and compress them into a single commit. The commit messages will be preserved in the extended commit message for the commit, but the individual commits will be lost.
3434
- **Rebase and merge:** This option will take all of the commits and replay them as if they just happened. This allows GitHub to perform a fast forward merge (and avoids the addition of the merge commit).
3535

36-
### Updating Your Local Repository
36+
### Updating your local repository
3737

3838
When you merged your Pull Request, you deleted the branch on GitHub, but this will not automatically update your local copy of the repository. Let's go back to our command line application and get everything in sync.
3939

@@ -44,7 +44,7 @@ First, we need to get the changes we made on GitHub into our local copy of the r
4444

4545
`git pull` is a combination command that retrieves all of the changes from GitHub and then updates the branch you are currently on to include the changes from the remote. The two separate commands being run are `git fetch` and `git merge`
4646

47-
### Cleaning Up the Unneeded Branches
47+
### Cleaning up the unneeded branches
4848

4949
If you type `git branch --all` you will probably see that, even though you deleted your branch on the remote, it is still listed in your local copy of the repository, both as a local branch and as a read-only remote tracking branch. Let's get rid of those extra branches.
5050

Diff for: docs/10_local_history.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## Viewing Local Project History
1+
## Viewing local project history
22

33
In this section, you will discover commands for viewing the history of your project.
44

5-
### Using Git Log
5+
### Using Git log
66

77
When you clone a repository, you receive the history of all of the commits made in that repository. The log command allows us to view that history on our local machine.
88

0 commit comments

Comments
 (0)