310
edits
Changes
Jump to navigation
Jump to search
|-
|status
|<code>git status [options]</code>
|checks the status of the repo; shows a visual distinguishing among files which have and haven't been included in the repo, files which have been modified and staged, et al.
|<code>git status</code>
== More information ==Git's A very thorough [https://git-scmwww.sbf5.com/docs ~cduan/technical/git/ reference manualguide]
Git Another git [https://sentheonstackoverflow.com/blogquestions/2428722/git-cheatbranch-strategy-for-small-dev-sheet.html#.WYszfVWGOUk cheat sheetteam on a team]source
big ol' edit
[[File:Poor_project_management.png|right|frame|Has this ever happened to you? No more, with version control!]]
''(Generally, this workshop is offered at least once a week on a rotating basis. Check the [http://designandbuildlab.com/?page_id=445/ Lab calendar] for up-to-date availability!)''
'''Version control''' is a technique for managing the complexity of a digital project, - especially those one which are is done collaboratively.
== What is version control? ==When a project is in its infancy, it is fairly straightforward to keep track of the files contained within; it can, however, become unmanageable very quickly - especially if revisions happen frequently. Version control can be imagined as a series of '''snapshots''' of a project's changes as time progresses; it effectively stores the entire history of the project. Each snapshot allows you to see exactly the state of the project at that time; you can travel back to any of these snapshots at any time, and fast forward back to the future.
The version control information (the files, the snapshot information, et al.) are held ''locally'' in a folder called a '''repository''', or repo. You Additionally, you can additionally sync this repo to a server somewhere else - this copy of the repo called a '''remote'''. This The remote can serve as a backup, as well as a way to ''share the repo with others'' who may also be working on the project.
A '''version control system''' (VCS) is a tool that handles all of this complexity: the repo itself, the snapshots, the remote(s), et al. There are many VCsVCS's; the most popular is called '''[https://git-scm.com/downloads git]'''.
=== Why use version control? ===
The two advantages that version control provides:
# ''You are able to travel back in time to any point in a project and utilize it from that moment''; and
# if you use a remote, ''collaboration is not only straightforward, it is encouraged''. === Terminology ==='''repository''': the location and contents Management of a collaborative project, including all version control information is streamlined'''commit''' '''(n)''': a particular snapshot of a project '''commit''' '''(v)''': to take a snapshot of a project '''remote''': a copy of project, stored on a server somewhere else '''branch''': a particular timeline of snapshots - the main branch is typically called "master"; other branches may be used to develop new features without risking the master branch's stability.
== Utilizing version Control ==
** [https://bitbucket.org/ Bitbucket] is recommended because it offers free private repos for small teams.
** [https://github.com/ Github] is the most widely used web-based repository.
* Git is accessed through the command line interface (CLI) of your choice:**''Windows'': you can use Git Bash (which was installed should install when you installed git) or PowerShell; Bash is preferred because it is nicely color-coded.)**''Linux/MacOS'': terminal (which is installed with the operating system). === Acquiring a repo ===There are two main ways to work with a repo: create one yourself, or use someone else's.
=== Setting up a repo = I want to create one myself! ====There *If you are several ways only going to do be working on this; the easiest way is to create a new repo on Bitbucket or Githubrepository locally, and then duplicate it on your local machine using a CLI of your choice:*# Navigate In your CLI, navigate to the place you'd like to save the repo folder: <code>cd [path]</code>*# Locate and copy the url for the git remote; in bitbucket, this is in the top-right corner of Create the repo's main page.folder: <code> mkdir [repository folder name]</code>*# Use the ''clone'' function of git to download a copy of Navigate into the repo locallyfolder: <code>git clone cd [the_link_you_copied_in_step_2.repository folder name</code>*# Initialize the repository: <code>git]init</code>You can now begin adding files in your repo!
*If instead, you are going to be working with a remote, then:*# Create a new repo on your remote of choice.*# Locate and copy the url for the git remote. Typically, this is in the top-right corner of the repo's main web page.*# In your CLI, navigate to the place you'd like to save the repo folder: <code>cd [path]</code>*# Use the ''clone'' function of git to download a copy of the repo locally: <code>git clone [the_link_you_copied_in_step_2.git]</code>*# You can now begin working with your repo! ==== I want to work with someone else's! ====*This process is also simple: ''find'' a repo that you'd like to work with on a remote, and clone it onto your system:*# Find a remote repository you'd like to work with.*# Locate and copy the url for the git remote. Typically, this is in the top-right corner of the repo's main web page.*# In your CLI, navigate to the place you'd like to save the repo folder: <code>cd [path]</code>*# Use the ''clone'' function of git to download a copy of the repo locally: <code>git clone [the_link_you_copied_in_step_2.git]</code>*# You can now begin working with your repo! ===Working with a repo===
==== Typical workflow ====
#'''Commit''' those changes to the repository: <code>git commit -m "[a message describing the changes]"</code>
#'''Push''' the new commit to the remote repository: <code>git push [remote name] [branch name]</code>
== Terminology ==
'''repository''': the location and contents of a project, including all version control information
'''commit''' '''(n)''': a particular snapshot of a project
'''commit''' '''(v)''': to take a snapshot of a project
'''local''': a copy of project stored on your system
'''remote''': a copy of project stored on a server somewhere else
'''branch''': a particular timeline of snapshots - the main branch is typically called "master"; other branches may be used to develop new features without risking the master branch's stability
== Common git commands ==
!Function
!Example usage
|-
|add
|<code>git add [filename]</code>
|stages files; these files are ready to will then be committedduring a <code>commit</code>.
|<code>git add README.md</code>
|-
|branch
|<code>git branch [-b] [new branch name]</code>
|create a new branch; the option -b flag will immediately <code>checkout</code> the new branch.
|<code>git branch experimental</code>
|-
|checkout
|<code>git checkout [branch or snapshot name]</code>
|switches the repository over to a particular snapshot or branch; typically snapshots are referenced by a hash.
|<code>git checkout experimental</code>
|-
|commit
|<code>git commit -m "[commit message]"</code>
|commits writes changes to the repo, or otherwise known as "taking a snapshot".
|<code>git commit -m "changed header"</code>
|-
|fetch
|<code>git fetch [remote branch name]</code>
|grabs the remote branch's snapshots not on the local machine and stored them locally; ''does not merge''. branch name optional.
|<code>git fetch</code>
|-
|log
|<code>git log</code>
|-
|checkoutmerge|<code>git checkout merge [branch or snapshot nameto be merged]</code>|rolls the repository over in time inserts branch to a particular snapshot; typically be merged's snapshots are referenced by a hashinto current branch's history.|<code>git checkout a65f27master</code><br><code>git merge experimental</code><br>merges <code>experimental</code> into <code>master</code>
|-
|pull
|<code>git pull [options]</code>
|checks the remote for any new commits not on your local timeline; if so, downloads them to your local repo, then fast-forwards your local repo to the current snapshot. this is effectively a <code>fetch>/code> followed by a <code>merge</code>.
|<code>git pull</code>
|-
|push
|<code>git push [remote name] [branch name]</code>
|connects to the remote and copies any new snapshots on your system to it.
|<code>git push origin master</code>
|-
|rebase
|<code>git rebase [-i] [snapshot or branch name]</code>
|folds all snapshots from current to target snapshot or branch name; this seems like editing history, but is very useful when working on larger teams, to condense your changes into one snapshot (which will be merged into the target branch) so that it doesn't flood the target branch with hundreds of commits from each collaborator.
|<code>git rebase -i master</code>
|-
|status
|<code>git status [options]</code>
|checks the status of the repo; shows a visual distinguishing among files which have and haven't been included in the repo, files which have been modified and staged, et al.
|<code>git status</code>
|}
== Sample git workflow ==
The typical git workflow will depend on whether you're working on a personal repository or on a team.
{| class="wikitable"
! style="text-align:center;"|Simple personal workflow:||Team workflow:
|-
|[[File:Gitworkflow.png|600px]]||[[File:Git_workflow_team.gif|400px]]
|}
== Flow chart External Links ==Git's [https://git-scm.com/docs git's own reference manual] Roger Dudler's [Filehttps:Gitworkflow//rogerdudler.github.pngio/git-guide/ simple git guide] Git [https://sentheon.com/blog/easy-git-guide-and-reference-for-the-busy.html guide and reference] Git [https://sentheon.com/blog/git-cheat-sheet.html cheat sheet]
Git [https://sentheonjameschambers.comco/blogwriting/easy-git-guideteam-andworkflow-reference-for-the-busy.html#.WYs4y1WGOUk guide and referencecheatsheet/ on a team]
