forked from learn-co-curriculum/phase-0-git-basics-lab
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
deeper explanation of -u flag + more (learn-co-curriculum#12)
* deeper explanation of -u flag + more standardized capitalization of GitHub; added GitHub icons; edited for grammar/typos/readability; changed "click the 'Create New Repository' button" to the much simpler github.com/new * Update README.md
- Loading branch information
Showing
1 changed file
with
33 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,59 +1,58 @@ | ||
| #Git Remotes + Github Code Along | ||
| #Git Remotes + GitHub Code-Along | ||
|
|
||
| ##Objectives | ||
| 1. Describe Github and its relationship with git | ||
| 2. Create a remote repository on Github | ||
| 3. Use git push to connect your local repository of files to your remote repository | ||
| 4. Use git remote | ||
| 5. Use git push | ||
| 6. Use git pull | ||
| 1. Describe GitHub and its relationship with Git | ||
| 2. Create a remote repository on GitHub | ||
| 3. Use `git push` to connect your local repository of files to your remote repository | ||
| 4. Use `git remote` | ||
| 5. Use `git push` | ||
| 6. Use `git pull` | ||
|
|
||
| Let's go through an example to clarify remote repositories on Github. | ||
| Let's go through an example to clarify remote repositories on GitHub. | ||
|
|
||
| ##Create a local directory | ||
| 1. Create a folder: `mkdir git-remote-code-along` | ||
| 2. Change directory: `cd git-remote-code-along` | ||
| 2. Add a README: `touch README.md` | ||
|
|
||
| ##Creating a remote repository on Github | ||
|
|
||
| 1. From your Github profile, click the "Create New Repository" button. | ||
| 2. After you create the repo, click the "Copy to clipboard" symbol on the right-hand side of the screen to copy the clone url (we'll use this in the next section) | ||
| 1. In your development directory, create a folder: `mkdir git-remote-code-along`. | ||
| 2. Change directory: `cd git-remote-code-along`. | ||
| 3. Add a README: `touch README.md`. | ||
|
|
||
| ##Creating a remote repository on GitHub | ||
| 1. Go to [github.com/new](https://github.com/new). | ||
| 2. After you create the repo, click the "Copy to clipboard" symbol on the right-hand side of the screen () to copy the clone url (we'll use this in the next section). | ||
|
|
||
| ##Connecting your remote repo to a local repo | ||
| 1. `git init` | ||
| 2. `git add .` + `git commit -m "initialize git"`. Add and commit the new file created by the init command in the step 1. | ||
| 1. `git init`. | ||
| 2. `git add .` + `git commit -m "initialize git"`. Add and commit the new file created by the `git init` command in step 1. | ||
| 3. `git remote add origin your-remote-repository-URL`. This sets the remote, so you can push and pull code. | ||
|
|
||
| ##Push code to Github | ||
| ##Push code to GitHub | ||
| 1. Let's add something to our README. Open the file and add whatever text you'd like. | ||
| 2. Now look at the remote repo on Github. Notice that the new text in your README is not there. Let's fix this by pushing our code up to Github. | ||
| 3. If we `git push` right away, we still won't get the changes because we have not tracked and committed the changes. Let's do that: `git add .` and `git commit -m "add content to README"` | ||
| 4. Now we can `git push -u origin master`. The `-u` to git push means, as well as pushing, associate my master branch with the one I'm pushing to. | ||
| 5. Confirm that your changes are now on Github, and you're done! | ||
|
|
||
|
|
||
| ##Pull code from Github | ||
| 2. Now look at the remote repo on GitHub. Notice that the new text in your README is not there. Let's fix this by pushing our code up to GitHub. | ||
| 3. If we `git push` right away, we still won't get the changes because we have not tracked and committed the changes. Let's do that: `git add .` and `git commit -m "add content to README"`. | ||
| 4. Now we can `git push -u origin master`. We only need to apply the `-u` flag (short for `--set-upstream`) the first time we use `git push`. It tells the current local branch to track itself against the `master` branch of `origin`, the remote repo we're pushing to. After you've set the upstream link with `-u`, you can use `git push` and `git pull` without specifying any arguments (such as a target branch or repo). | ||
| 5. Confirm that your changes are now visible on GitHub, and you're done! | ||
|
|
||
| ##Pull code from GitHub | ||
| ```bash | ||
| git pull | ||
| ``` | ||
|
|
||
| This command takes any changes on your remote repository and "pulls" it down to your local code. Try running it in your terminal now. In our case, there's nothing to pull so you should see a message that says `Already up-to-date.` | ||
| This command takes any new changes to the remote repository and "pulls" them down to your local code. Try running it in your terminal now. In our case, there's nothing to pull, so you should see a message that says `Already up-to-date.` | ||
|
|
||
| Sometimes the code on your remote gets ahead of your local code. This could be because you're collaborating with others. It can also occur when you change it directly on Github. Let's try this. | ||
| Sometimes the code on your remote gets ahead of your local code. This happens often when collaborating with others, but it can also happen when you edit code directly on [GitHub.com](https://github.com/). Let's give that a try. | ||
|
|
||
| Let's say you liked your README, but you noticed a minor typo. Let's fix it directly on Github by clicking the README.md file. | ||
| ##Editing directly on GitHub | ||
| Say you liked your README, but you noticed a minor typo. Let's fix it directly on GitHub. | ||
|
|
||
| 1. At the top of the file, you'll notice a pencil icon. Clicking this will allow us to edit the file. | ||
| 2. Make some changes to the README | ||
| 3. Commit them by clicking the "Commit changes" button at the bottom of the page. | ||
| 1. Navigate to your remote repository on [GitHub.com](https://github.com/), e.g., https://github.com/username-here/repository-name-here. | ||
| 2. Click on your README file. | ||
| 3. At the top of the file, you'll notice a pencil icon (). Clicking this will allow us to edit the file. | ||
| 4. Make some changes to your README. | ||
| 5. Commit them by clicking the "Commit changes" button at the bottom of the page. | ||
|
|
||
| Perfect! The only problem is, now our code on our machine (our local repo) is out of sync with the remote repo. To remedy this, we must pull down the code to our local repo. No surprises here. To do this we run: | ||
| Perfect! But now the code on our machine (in our local repo) is out of sync with the remote repo. To remedy this, we must `pull` down the code to our local repo. To do so, run: | ||
|
|
||
| ```bash | ||
| git pull | ||
| ``` | ||
|
|
||
| <p data-visibility='hidden'>View <a href='https://learn.co/lessons/git-remote-code-along' title='Git Remotes + Github Code Along'>Git Remotes + Github Code Along</a> on Learn.co and start learning to code for free.</p> | ||
| <p data-visibility='hidden'>View <a href='https://learn.co/lessons/git-remote-code-along' title='Git Remotes + GitHub Code-Along'>Git Remotes + GitHub Code-Along</a> on Learn.co and start learning to code for free.</p> |