Editing Open Source Comes to Campus/Curriculum/Git/Instructors

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
 
= Leading 'Practicing Git' =
 
= Leading 'Practicing Git' =
  
Your goal, over the course of this 40-60 minute activity, is to help students experience what it is like to make changes to a project through GitHub.   
+
Your goal, over the course of this 40-60 minute activity, is to help students experience what it is like to make changes to a project through Github.   
  
 
== The background ==
 
== The background ==
  
We've created a GitHub organization for you to use, and given you administrative access to it.  Within that organization is a repository.  The repository is named $organization-name.github.io, because this is the name it needs to have for GitHub to automatically generate a [http://pages.github.com/ GitHub page].  You can see an unaltered example of a new organization with a new repository [https://github.com/princeton-9 here].
+
We've created a Github organization for you to use, and given you administrative access to it.  Within that organization is a repository.  The repository is named $organization-name.github.io, because this is the name it needs to have for Github to automatically generate a [http://pages.github.com/ Github page].  You can see an unaltered example of a new organization with a new repository [https://github.com/princeton-9 here].
  
Within the repository, we have created a set of bitesize issues for students to work on.  (See [https://github.com/princeton-9/princeton-9.github.io/issues here] for example.)  You will ask students to pick an issue to work on and claim it by leaving a comment.  Students can work by themselves or in groups.  If they decide to work together, try to have them leave all of their GitHub usernames somewhere on the GitHub issue that they solved as a group. That's for our record-keeping about how the event went.
+
Within the repository, we have created a set of bitesize issues for students to work on.  (See [https://github.com/princeton-9/princeton-9.github.io/issues here] for example.)  You will ask students to pick an issue to work on and claim it by leaving a comment.  Students can work by themselves or in groups.  If they decide to work together, try to have them leave all of their github usernames somewhere on the Github issue that they solved as a group. That's for our record-keeping about how the event went.
  
 
Sometimes a student will submit a pull request that needs fixing. For example:
 
Sometimes a student will submit a pull request that needs fixing. For example:
Line 27: Line 27:
 
* Asheesh recommends you encourage Windows and Mac users to stay away from "GitHub for Windows" and "GitHub for Mac" because the steps you need to follow with those are different than what we have documented. Others have disagreed on this, but that's what Asheesh thinks. (The laptop setup guide also steers clear of those, so if students are following directions, they will do things the Asheesh way.)
 
* Asheesh recommends you encourage Windows and Mac users to stay away from "GitHub for Windows" and "GitHub for Mac" because the steps you need to follow with those are different than what we have documented. Others have disagreed on this, but that's what Asheesh thinks. (The laptop setup guide also steers clear of those, so if students are following directions, they will do things the Asheesh way.)
  
* Your main repository is configured, via [http://pages.github.com/ GitHub Pages], to load on the web at a HTTP URL the same as the repository name. So, once you merge students' pull requests, they should be visible on the web at that address.
+
* Your main repository is configured, via [http://pages.github.com/ Github Pages], to load on the web at a HTTP URL the same as the repository name. So, once you merge students' pull requests, they should be visible on the web at that address.
 
** Note that it may take up to 2 minutes for the site to update with new changes. So don't expect it all to happen immediately.
 
** Note that it may take up to 2 minutes for the site to update with new changes. So don't expect it all to happen immediately.
 
** There may also be issues with caching.  To get around this problem, add "/?" to the end of the url.
 
** There may also be issues with caching.  To get around this problem, add "/?" to the end of the url.

Please note that all contributions to OpenHatch wiki are considered to be released under the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) (see OpenHatch wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)