-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Kristen Hackett
authored and
Kristen Hackett
committed
Aug 6, 2020
1 parent
0a424a6
commit 3e7ea16
Showing
10 changed files
with
115 additions
and
1 deletion.
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
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 |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Cloning | ||
|
||
Cloning a repository means making a copy of a repository on GitHub, to download and work on locally--on your local machine. | ||
|
||
Cloning can be especially useful when you're joining a group project that is hosted on GitHub, and you want your changes to eventually be pushed and shared with that same repository. | ||
|
||
Cloning can also be used in conjunction with forking. For example, you could fork the GitHub repository of this lesson to your GitHub account, and then clone or download the repository to make edits and admendations. Then you would push those changes to a repository under your GtiHub account. Git and GitHub work to make sure attribution of contributions and lineage are transparent. | ||
|
||
## Tutorials | ||
|
||
- [Cloning a repository from GitHub](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github) |
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 |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Commit | ||
|
||
When you commit your changes using Git, you are created a version a file that can be referenced even after further changes to the file are made and committed. | ||
|
||
Making a commit involves 2 steps. | ||
- First, you need to stage the files, or tell Git, which files it should pay attention to. Where are your changes? You use the command `git add` to point to them. | ||
- Second, you create the version by committing the changes. You use the command `git commit` to take the snapshot and add a label (the -m flag) that can help you in returning to that version in the future. | ||
|
||
Making a commit is a lot like taking a photo. First, you have to decide who will be in the photo and arrange your friends or family in front of the camera (the staging process). Once everyone is present and ready, you take the picture, entering that moment into the permanent record (the commit process). | ||
|
||
Before any of this can happen, you must initialize the Git folder, or put it on Git's radar. This only needs to happen one time to a folder. |
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 |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Forking | ||
|
||
Forking is a proper function of the GitHub platform. It supports collaboration by allowing you to copy someone else's repository to your own account on GitHub while maintaining a trail of attribution and derivation. | ||
|
||
Once the files are forks, you can clone or download them, edit them, and share your changes on GitHub. Git and GitHub help track and be transparent about contributions or attribution. | ||
|
||
## Tutorials | ||
|
||
- [About Forking](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-forks). GitHub Writing. |
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 |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Git | ||
|
||
Git is software used for version control—that is, tracking the state of files and changes you make to them over time. Git can be enabled in a folder, and then used to save the state of the contents in that folder at different points in the future, as designated by you. | ||
|
||
Git is also useful for collaboration, as a repository can be shared across computers, and its contents can be asynchonously developed and eventually merged with the main project. | ||
|
||
In this workshop, you'll use Git on your local machines to track changes you make to a file. | ||
|
||
## Readings | ||
|
||
- Perez-Riverol, Y. and colleagues. (2016) _[Ten Simple Rules for Taking Advantage of Git and GitHub](https://doi.org/10.1371/journal.pcbi.1004947)._ PLOS Computational Biology. | ||
- Chacon, S. and Straub, B. [Pro Git](https://git-scm.com/book/en/v2). Published by Apress. | ||
|
||
## Tutorials | ||
|
||
- [An intro to Git: What it is and how to use it](https://www.freecodecamp.org/news/what-is-git-and-how-to-use-it-c341b049ae61/) |
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 |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# GitHub | ||
|
||
GitHub is a online platform for hosting Git repositories. It functions for some, predominantly programmers, as a social network for sharing and collaborating on code-based projects. Users can share their own projects, as well as search for others, which they can then often work on and contribute to. | ||
|
||
Digital Humanists, librarians, and other academics are also finding ways Git and GitHub are useful in writing projects and teaching. | ||
|
||
GitHub also serves as a web-hosting platform, allowing users to create websites from their repositories. | ||
|
||
## Readings | ||
|
||
- Pe-Than, E.P.P., Dabbish, L. and Herbsleb, J.D. (2019). [Collaborative Writing at Scale: A Case Study of Two Open-Text Projects Done on GitHub](https://ci.acm.org/2019/assets/proceedings/CI_2019_paper_65.pdf).Collective Intelligence. | ||
|
||
|
||
## Tutorials | ||
|
||
- [Getting Started with GitHub](https://help.github.com/en/github/getting-started-with-github) | ||
- Miyake, K. (2016). [Create Your (FREE) Website Using Github and Jekyll](https://digitalfellows.commons.gc.cuny.edu/2016/03/21/create-your-free-website-using-github-and-jekyll/). Tagging the Tower blog. | ||
- Visconti, A. (2016). [Building a static website with Jekyll and GitHub Pages](https://programminghistorian.org/en/lessons/building-static-sites-with-jekyll-github-pages). Programming Historian. |
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 |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Markdown | ||
|
||
Markdown is the language used to format the plain text files in your Git-enabled repository. Its also called a markup language, like HTML. Both languages add markers to plain text to style and organize the text of a document. | ||
|
||
``` | ||
In HTML: | ||
<h1> Heading 1 </h1> | ||
In Markdown: | ||
# Heading 1 | ||
``` | ||
|
||
Whereas you use HTML and CSS with WordPress, you use Markdown with Git and GitHub. Markdown has fewer options for marking text than HTML. It was designed to be human-readable, meaning easy to write and edit. | ||
|
||
## Readings | ||
|
||
- Coll, S. (2017). [Markdown for Students and Academics](https://www.simondcoll.com/markdown-students-academics/). | ||
- Ovadia, S. (2014). [Internet Connection: Markdown for Librarians and Academics](https://academicworks.cuny.edu/cgi/viewcontent.cgi?article=1006&context=lg_pubs) | ||
|
||
## Tutorials | ||
|
||
- [Mastering Markdown](https://guides.github.com/features/mastering-markdown/). GitHub Guides. |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Push | ||
|
||
When you push your files, or use the command `git push master origin`, you are communicating with GitHub to update the connected project folder stored there. You are pushing the changes, say, to your syllabus.md file stored on their servers which you access via your gitHub.com. | ||
|
||
## Tutorials | ||
|
||
- [Pushing commits to a remote repository](https://docs.github.com/en/github/using-git/pushing-commits-to-a-remote-repository). GitHub Writing. |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Repository | ||
|
||
Git uses the term repository to refer to a folder that is being tracked. Colloquially, this term is often shortened to "repo". | ||
|
||
# Readings | ||
|
||
[About Repositories](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repositories). Writing on GitHub. |
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 |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Version Control | ||
|
||
Version control is a system that records changes to a file or set of files over time so that you can recall specific versions later. It allows you to revert selected files back to a previous state, revert the entire project back to a previous state, compare changes over time, see who last modified something that might be causing a problem, who introduced an issue and when, and more. | ||
|
||
Using a version control software like Git generally means that if you screw things up or lose files, you can easily recover. In addition, you get all this for very little overhead. | ||
|
||
## Readings | ||
|
||
- Bryan, J. (2017). _[Excuse me, do you have a moment to talk about version control?](https://doi.org/10.7287/peerj.preprints.3159v2)_ PeerJ Preprints. | ||
|
||
## Tutorials | ||
|
||
- [Getting Started - About Version Control](https://git-scm.com/book/en/v2/Getting-Started-About-Version-Control). Git documentation. |