Git Guide - Revision history

Ganskop: Add prompt customization

2025-02-05T14:57:29Z

Add prompt customization

← Older revision		Revision as of 10:57, 5 February 2025
Line 186:		Line 186:
	* when pushing a branch to the remote repo, it'll default to the current branch name (which is almost always what you want) so you don't have to specify a remote name		* when pushing a branch to the remote repo, it'll default to the current branch name (which is almost always what you want) so you don't have to specify a remote name
	*it'll cache your password/token for 604,800 seconds (1 week)		*it'll cache your password/token for 604,800 seconds (1 week)

			== Prompt Customization ==
			You can (and should!) use a tool like [https://github.com/diogocavilha/fancy-git fancy-git] to include the Git branch name and status in your terminal prompt.

			[[File:Fancy-git.png\|alt=fancy-git\|365x365px]]

			A simpler version is [https://github.com/git/git/blob/master/contrib/completion/git-prompt.sh git-prompt] with [https://github.com/git/git/blob/master/contrib/completion/git-completion.bash git-completion] (both from the actual Git project).

			[[File:Git-prompt.png\|alt=git-prompt\|319x319px]]

	==Commit Message Best Practices==		==Commit Message Best Practices==

Ganskop: Add Git stash info

2023-04-26T17:44:34Z

Add Git stash info

← Older revision		Revision as of 13:44, 26 April 2023
Line 226:		Line 226:

	Most of these rules are taken from Chris Beams. [https://cbea.ms/git-commit/#seven-rules See his blog post] for a more thorough explanation of these rules.		Most of these rules are taken from Chris Beams. [https://cbea.ms/git-commit/#seven-rules See his blog post] for a more thorough explanation of these rules.

			== Git Stash ==
			When you have code that you have modified and you need to switch between branches, but you don't yet want to commit your changes, you can utilize Git's built-in command called 'stash':

			Check out [https://git-scm.com/book/en/v2/Git-Tools-Stashing-and-Cleaning Pro Git: Stashing and Cleaning], which is where this info came from.

			You can check what the current status is of your git repo vs. your local files by calling:

			<pre>
			git status

			On branch main
			Changes to be committed:
			(use "git reset HEAD <file>..." to unstage)

			modified: README.md
			modified: src/pages/registration.js

			Changes not staged for commit:
			(use "git add <file>..." to update what will be committed)
			(use "git checkout -- <file>..." to discard changes in working directory)

			modified: src/pages/login.js
			</pre>

			Then once you have established that there are changes you want to keep track of, stash them:
			<pre>
			git stash
			</pre>

			When you call <code>git status</code>, you can see that your repo has been reverted and your changes are safely stored away:

			<pre>
			git status

			# On branch main
			nothing to commit, working directory clean
			</pre>

			You can have multiple stashes, so make sure you check to see where in the list of stashes this is located:
			<pre>
			git stash list
			stash@{0}: WIP on 2-create-registration: 47a498d #2 Add desc to readme
			stash@{1}: WIP on 4-create-upload-page: c264051 #4 Add upload handling
			stash@{2}: WIP on 4-create-upload-page: 21d80a5 #4 Create upload page
			</pre>

			When you want to get your stash out of hiding, you use the <code>pop</code> command:
			<pre>
			git stash pop
			</pre>

			And you can specify which stash to retrieve by supplying a stash index:
			<pre>
			git stash pop stash@{2}
			</pre>

Ganskop: Added intro

2023-04-26T17:26:20Z

Added intro

← Older revision		Revision as of 13:26, 26 April 2023
Line 1:		Line 1:
	== Getting Started ==		== Getting Started ==

			=== What is Git? ===
			Git is a distributed version control system used for tracking changes in source code and other files during software development. It was created by Linus Torvalds in 2005 for managing the development of the Linux kernel. Git allows developers to work on a codebase simultaneously and independently, without overwriting each other's changes.

			Git is designed to be fast, efficient, and secure. It keeps a complete history of changes made to a project, allowing developers to revert to previous versions if necessary. Git uses a branching model, which enables developers to work on different features or bug fixes in parallel and merge changes back into the main codebase.

			Git has become the industry standard for version control and is widely used in software development. It also has a large and active open-source community, which provides a wealth of resources and tools for developers.

			Git stores code in repositories (or "repos" [pronounced ree-poe]); you can "check out" a repository to get the latest version of the code.

			'''It's important to remember that when we're talking about Git repositories, we're typically talking about ''two'' versions of the repository: one that's running on a server (aka the "remote" or "origin"), such as GitHub, and one that's running on your computer (aka the "local", which is "cloned" from the remote). When you commit changes to your local repo, those changes are not available to anyone else in your group until you "push" the changes to the remote.'''

	=== Access Tokens ===		=== Access Tokens ===

Ganskop: Update Gitflow

2023-04-26T17:18:32Z

Update Gitflow

Show changes

Ganskop at 16:59, 26 April 2023

2023-04-26T16:59:07Z

← Older revision		Revision as of 12:59, 26 April 2023
Line 16:		Line 16:
	=== Create and check out the branch ===		=== Create and check out the branch ===
	In the GitHub issue, click "Create a branch":		In the GitHub issue, click "Create a branch":
	[[File:Create a branch.png\|alt=create a branch\|313x313px]]This will automatically name the branch with the issue's ID and name:
			[[File:Create a branch.png\|alt=create a branch\|313x313px]]


			This will automatically name the branch with the issue's ID and name:

	[[File:Branch name.png\|alt=branch name\|322x322px]]		[[File:Branch name.png\|alt=branch name\|322x322px]]


	Then check out the branch in your local repository (where <feature-branch> is the name of the branch, e.g., "4-create-upload-page"). You'll have to fetch first so that the local repo knows that the branch exists.		Then check out the branch in your local repository (where <feature-branch> is the name of the branch, e.g., "4-create-upload-page"). You'll have to fetch first so that the local repo knows that the branch exists.
	git fetch		git fetch
Line 28:		Line 35:
	git checkout -b <feature-branch>		git checkout -b <feature-branch>
	</pre>		</pre>





Line 33:		Line 43:

	[[File:Link branch.png\|alt=link branch\|291x291px]]		[[File:Link branch.png\|alt=link branch\|291x291px]]

Ganskop at 00:21, 24 April 2023

2023-04-24T00:21:09Z

← Older revision		Revision as of 20:21, 23 April 2023
Line 14:		Line 14:
	If you're working on a larger project, especially one with multiple versions in production simultaneously, [https://nvie.com/posts/a-successful-git-branching-model/ check out the branching model from Vincent Driessen].		If you're working on a larger project, especially one with multiple versions in production simultaneously, [https://nvie.com/posts/a-successful-git-branching-model/ check out the branching model from Vincent Driessen].

	Retrieve the main branch, make sure it's up-to-date, and create your feature branch from that, where <feature-branch> is the ID of the ~~task ticket~~, such as "~~PROJ~~-~~123~~". Your branch must be named with the Jira ticket ID so that your development progress will be tracked in Jira.		=== Create and check out the branch ===
	<pre>		In the GitHub issue, click "Create a branch":
			[[File:Create a branch.png\|alt=create a branch\|313x313px]]This will automatically name the branch with the issue's ID and name:
			[[File:Branch name.png\|alt=branch name\|322x322px]]
			Then check out the branch in your local repository (where <feature-branch> is the name of the branch, e.g., "4-create-upload-page"). You'll have to fetch first so that the local repo knows that the branch exists.
			git fetch
			git checkout <feature-branch>


			Alternatively, you can create the branch locally, but you should still use the same naming convention. Retrieve the main branch, make sure it's up-to-date, and then create your feature branch from that, where <feature-branch> is the ID and name of the GitHub issue, such as "4-create-upload-page". Your branch must be named with the Jira ticket ID so that your development progress will be tracked in Jira.<pre>
	git checkout main		git checkout main
	git pull		git pull
	git checkout -b <feature-branch>		git checkout -b <feature-branch>
	</pre>		</pre>


			When you create a branch through the GitHub issue, it'll automatically be linked with the issue. If you create the branch locally, you'll have to link the branch manually in the GitHub issue:

			[[File:Link branch.png\|alt=link branch\|291x291px]]


	When resuming work on a feature, retrieve your branch:		When resuming work on a feature, retrieve your branch:
	git checkout <feature-branch>		git checkout <feature-branch>

Ganskop: Add gitconfig

2023-04-21T16:06:52Z

Add gitconfig

Show changes

Ganskop at 14:58, 21 April 2023

2023-04-21T14:58:15Z

← Older revision		Revision as of 10:58, 21 April 2023
Line 79:		Line 79:
	# Separate subject from body with a blank line		# Separate subject from body with a blank line
	#* In the longer example: see how there's nothing on the second line?		#* In the longer example: see how there's nothing on the second line?
	# Limit the subject line to 80 characters		# Limit the subject line to 80 characters and wrap the body at 80 characters
	#* In the example: even with the ticket number, the total length of the subject line is 56 characters		#* In the example: even with the ticket number, the total length of the subject line is 56 characters
	# Capitalize the subject line		# Capitalize the subject line
Line 88:		Line 88:
	#* In the example: it's "Refactor function", not "Refactored function" or "Refactors function"		#* In the example: it's "Refactor function", not "Refactored function" or "Refactors function"
	#* When you're reading through commits and determining what will happen if you merge the commit into your branch, you should be able to prepend each commit message with, "If I merge this commit, it'll <commit message>". E.g., "If I merge this commit, it'll refactor function foobar() to reduce complexity"		#* When you're reading through commits and determining what will happen if you merge the commit into your branch, you should be able to prepend each commit message with, "If I merge this commit, it'll <commit message>". E.g., "If I merge this commit, it'll refactor function foobar() to reduce complexity"
	~~# Wrap the body at 80 characters~~
	# Use the body to explain ''what'' and ''why'', not ''how''		# Use the body to explain ''what'' and ''why'', not ''how''
			#* E.g., don't say: "Call filter_var( $input, FILTER_SANITIZE_EMAIL )" ''Do'' say: "Sanitize email input to prevent CSS"


	Most of these rules are taken from Chris Beams. [https://cbea.ms/git-commit/#seven-rules See his blog post] for a more thorough explanation of these rules.		Most of these rules are taken from Chris Beams. [https://cbea.ms/git-commit/#seven-rules See his blog post] for a more thorough explanation of these rules.

Ganskop: Add commit message best practicies

2023-04-19T17:54:18Z

Add commit message best practicies

@@ Line 1: / Line 1: @@
 == Getting Started ==
-==== Access Tokens ====
+=== Access Tokens ===
 In order to access iSchool repos on GitHub Education, you’ll need to create a personal access token, which will be used like a password. [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-personal-access-token-classic Follow the steps in the GitHub documentation] to create your personal access token. Make sure you save your access token someplace where you'll be able to find it again; once you leave the GitHub page where the token was created, you won't be able to see it there again.
 Note that when you're prompted for a password, like when calling <code>git push</code>, you actually need to enter your access token.
-==== Installing Git ====
+=== Installing Git ===
 If you don’t already have Git on your computer, you’ll need to [https://git-scm.com/book/en/v2/Getting-Started-Installing-Git install it].
@@ Line 53: / Line 53: @@
 ======<code>git fetch</code>======
 Get the list of available branches from a remote repository; often needed before “git pull”

Ganskop at 17:20, 19 April 2023

2023-04-19T17:20:08Z

← Older revision		Revision as of 13:20, 19 April 2023
Line 9:		Line 9:
	If you don’t already have Git on your computer, you’ll need to [https://git-scm.com/book/en/v2/Getting-Started-Installing-Git install it].		If you don’t already have Git on your computer, you’ll need to [https://git-scm.com/book/en/v2/Getting-Started-Installing-Git install it].

	=Git Commands Reference=		== Git Commands Reference ==

	======<code>git clone</code>======		======<code>git clone</code>======