Anonymous user
Open Source Comes to Campus/Curriculum/Git/Students: Difference between revisions
Open Source Comes to Campus/Curriculum/Git/Students (view source)
Revision as of 03:29, 18 April 2015
, 9 years ago→Resolving Merge Conflicts
imported>Shauna |
|||
| (28 intermediate revisions by 6 users not shown) | |||
Line 1:
__NOTOC__
== Make sure you have git set up ==
This can be done by typing the following into your console:
git --version
If your computer doesn't have git, then follow the laptop setup guide by going to your event's home page (e.g. http://ccsf.openhatch.org/ ) and then looking for the laptop setup guide.
== Visiting the project on the web ==
Since this project is a website, we've specially configured the repository so that whenever there is a push to it, it is made visible on the web.
If your group's repository is called e.g. ''waffle-castle.github.io'', then you can see that the shared version is visible on the web at http://waffle-castle.github.io/. (This is just an example. Your group's repository name should be "schoolname-#.github.io" and its shared page should be at http://schoolname-#.github.io (for example, http://princeton-1.github.io or http://princeton-2.github.io.))
But note that any changes in your ''fork'' (your personal copy of the repo) won't show up there until the maintainer of the project merges those changes in.
== Find a task ==▼
Now, find a bug on the project's issue tracker that you will work on, and claim it by leaving a comment on the issue saying so.▼
(Before you do that, make sure to refresh the page and check that no one else has claimed it while you were reading and deciding.)▼
== To fork a project on Github ==
Line 21 ⟶ 36:
== Now, clone to it to your computer ==
* On the right side, look for the clone URL directly under the settings button.
* Copy that to the clipboard
* Open a terminal
* Once you're at the direction, type into the terminal: <code>"git clone "</code> (including the spaces, but not including the quotation marks)
* Use your terminal to "paste" the URL in. (Make sure it starts with <code>https</code>; if not, you'll need to use an ssh key and most students probably won't a key already set up)▼
▲* Use your terminal to "paste" the URL in. (Make sure it starts with <code>https</code>; if not, you'll need to use an ssh key and most students probably won't have a key already set up)
* Terminal should now look something like this:
git clone https://github.com/<rest of clone url>
* Press enter to do the "<code>git clone</code>" operation.
Line 42 ⟶ 63:
* Undo that change, with your editor, save, and then reload in the browser. Make sure what you see in the browser reflects that change.
▲== Find a task ==
▲Now, find a bug on the project's issue tracker that you will work on, and claim it by leaving a comment on the issue saying so.
▲(Before you do that, make sure to refresh the page and check that no one else has claimed it while you were reading and deciding.)
== Resolve the task ==
Line 56 ⟶ 71:
== Commit and push ==
Make sure you're in the directory you cloned the git repository to, with a command like:
cd $your-repository-name
Once you're finished making changes, you can use the following command to get a list of files you've changed:
Line 81 ⟶ 100:
== Create pull request ==
Visit your personal fork and click the "Pull requests" button on the right. This will offer you the chance to make a new pull request by clicking on "New pull request". Explain what you did, and
Now, get feedback from the project's maintainer (the mentor leading your group) and eagerly await your pull request getting merged!
Line 90 ⟶ 109:
This is a special trick that we do during the Website editing with git exercise, using Github Pages. It demonstrates that when the merge happens, it can programmatically cause a different event; this is often called ''hooks''.
Sometimes your changes will not show because of caching. To get around this problem, add "/?" to the end of the url.
<div class="noprint">
== Advanced/Optional Commands ==
Line 116 ⟶ 139:
git fetch $name
git merge $name/master
To update your remote personal repository, you can type:
Line 134 ⟶ 157:
Your instructor should have showed you what she sees when you submit a pull request. Probably you saw a message from Github saying that the pull request could be "merged automatically". That means that you managed to avoid changing a part of the project that someone else also changed. Yay! That's how we designed this activity. But what happens if you ''do'' change the same part of a project as someone else? It generates what we call a "merge conflict".
(A brief thought experiment to explain merge conflicts: let's say there's a repository with a single file that says, '''Hello [celestial object]!''' If you change that to '''Hello world!''' and submit a pull request, you're creating a diff which says: ''change "[celestial object]" to "world"''. If someone else copied the repository at the same time as you and changed the same line, they might create a diff which says ''change "[celestial object]" to "galaxy"''. If you make your changes to the repository first, it now says '''Hello world!''', so when the other person says
To induce a merge conflict in this activity, go to the main github repository and find a change that has been made since the last time you copied the repository ("git clone" gets a copy, as does "git fetch" and "git pull"). Make a change, locally, to the same line.
There's two ways that this merge conflict can be solved. You could push your changes to your remote copy, then submit a pull request to your instructor. When viewing the pull request, they would be warned that changes could not be merged automatically:
[[File:Merge1.png]]
And would follow the instructions github helpfully provides to merge the changes:
[[File:Merge2.png]]
This involves some concepts like branching, which we haven't gotten to yet.
Alternatively, you could fix the merge conflict yourself. To do this, you'd need to get an up-to-date copy of the remote repository. To do this, type:
git fetch [url of main project]
Line 146 ⟶ 181:
git merge
This should result in a conflict. There are a number of tools you can use to help visualize merge conflicts. For simple conflicts, though, I like to use a basic editor, such as nano, vim, emacs, or whatever you're most comfortable with. In basic text view, a merge conflict looks like this:▼
[[File:merge3.png]]
▲There are a number of tools you can use to help visualize merge conflicts. For simple conflicts, though, I like to use a basic editor, such as nano, vim, emacs, or whatever you're most comfortable with. In basic text view, a merge conflict looks like this:
To resolve the conflict, scroll through the document until you find sections with these markings. The "
▲To resolve the conflict, scroll through the document until you find sections with these markings. The " " line separates the two options that are in conflict. Choose which one you want to keep by deleting the other. Then delete all of the markings. Do this for each conflict and then save and exit the file.
</div>
▲Congrats! You've resolved the conflict! You can commit your changes by:
| |||