Using git and GitHub - Revision history

Impaktor at 13:14, 3 October 2023

2023-10-03T13:14:55Z

Impaktor: Replaced content with "Page moved to: https://dev.pioneerspacesim.net/contribute/git-and-github"

2023-10-03T13:13:30Z

Replaced content with "Page moved to: https://dev.pioneerspacesim.net/contribute/git-and-github"

Show changes

Impaktor: /* Getting other developer's branches */

2023-09-10T11:01:36Z

‎Getting other developer's branches

Zonkmachine: Remove dead link

2023-01-02T20:05:49Z

Remove dead link

Zonkmachine: Fixing some more wonky links with

2023-01-02T05:20:07Z

Fixing some more wonky links with <pre>

Zonkmachine: /* Advanced */ Fix wonky links by preformatting examples with links

2023-01-02T05:00:30Z

‎Advanced: Fix wonky links by preformatting examples with links

Zonkmachine: /* Prerequisites */ msysgit superseded by Git for Windows

2023-01-02T03:50:50Z

‎Prerequisites: msysgit superseded by Git for Windows

Impaktor: /* Doing a hard reset */

2021-09-13T06:54:03Z

‎Doing a hard reset

Impaktor: /* Making a pull request */

2021-06-27T08:35:09Z

‎Making a pull request

Sturnclaw: /* Fixing/Updating your pull request */

2020-09-28T17:25:58Z

‎Fixing/Updating your pull request

← Older revision		Revision as of 13:14, 3 October 2023
Line 1:		Line 1:
	Page moved to:		Page moved to:
	https://dev.pioneerspacesim.net/contribute/git-and-github		https://dev.pioneerspacesim.net/contribute/git-and-github
		+
		+	Any edits should be made there, i.e. can use github editor and edit inplace
		+	https://github.com/pioneerspacesim/pioneer-developer-docs/blob/master/contribute/git-and-github.md

← Older revision		Revision as of 11:01, 10 September 2023
Line 392:		Line 392:

	git pull https://github.com/<developer-user-name>/pioneer.git <dev-branch>		git pull https://github.com/<developer-user-name>/pioneer.git <dev-branch>
		+
		+	If there is a conflict, to accept all their changes:
		+
		+	git pull -s recursive -X theirs https://github.com/<developer-user-name>/pioneer.git <dev-branch>

	If it's a developer you will often want to pull code from you can add him/her to your remote, just like you did with your own github <code>origin</code> and Pioneer's <code>upstream</code>.		If it's a developer you will often want to pull code from you can add him/her to your remote, just like you did with your own github <code>origin</code> and Pioneer's <code>upstream</code>.

@@ Line 85: / Line 85: @@
 == Basic operations ==
-At this point you might want to consider searching for tutorials. There are many good ones on git out there. If you're familiar with svn look [http://git.or.cz/course/svn.html here], and [http://marklodato.github.io/visual-git-guide/index-en.html this] is a nice visual representation of different commands, which might be helpful. Basic git tutorials on youtube: [https://www.youtube.com/watch?v=vaNGbk6HN9Y part 0], [https://www.youtube.com/watch?v=DQUcmNO4diQ part 1]. Below follows a few commands you will be using a lot, and be familiar with, but first make sure to delve into some tutorials. Git is a vast subject.
+At this point you might want to consider searching for tutorials. There are many good ones on git out there. [http://marklodato.github.io/visual-git-guide/index-en.html Here] is a nice visual representation of different commands, which might be helpful. Basic git tutorials on youtube: [https://www.youtube.com/watch?v=vaNGbk6HN9Y part 0], [https://www.youtube.com/watch?v=DQUcmNO4diQ part 1]. Below follows a few commands you will be using a lot, and be familiar with, but first make sure to delve into some tutorials. Git is a vast subject.
 Show documentation of command

@@ Line 57: / Line 57: @@
 You make your <code>local</code> repository by cloning a copy of your new <code>origin</code> repository to your local machine.
-At the command line, navigate to where on your filesystem you want to put your local git repos. For instance on Linux I put mine in <code>~/repos</code> whilst on Windows I put them in <code>c:\develop\github-repos</code>. You can move the folder at a later time without breaking anything. Once you're there execute the following command replacing <code>your github username</code> with, well, your github username.
+At the command line, navigate to where on your filesystem you want to put your local git repos. For instance on Linux I put mine in <code>~/repos</code> whilst on Windows I put them in <code>c:\develop\github-repos</code>. You can move the folder at a later time without breaking anything. Once you're there execute the following command replacing <code>your_username</code> with, well, your github username.
-  git clone [git://github.com/your https://github.com/your][https://github.com/your%20gituhub%20username/pioneer.git gituhub username/pioneer.git]
+<pre>
 Just like clicking Fork on the main Pioneer GitHub repo made a clone of it under your GitHub account, this makes a clone of that clone to your local machine. Expect this to take some time, just like before, as it copies all the files and the complete history of the project to your filesystem, only now it's sucking the data from GitHub to your machine, rather than copying things around within GitHub's data centre (so it will probably take even longer; however, a modern coputer does it on the order of minutes).
@@ Line 457: / Line 459: @@
 For those with push access to https://github.com/pioneerspacesim/pioneer this is one way to push code to master. First make sure you have a resonable setup:
+<pre>
   git remote -v
    origin	https://github.com/myusername/pioneer.git (fetch)
@@ Line 463: / Line 465: @@
    upstream	https://github.com/pioneerspacesim/pioneer.git (fetch)
    upstream	https://github.com/pioneerspacesim/pioneer.git (push)
+</pre>
 Also, it might be a god idea to clean your master branch, so you know it is identical to pioneer upstream, but do be warned, this will wipe your master branch, thus if you have commits that are not in their own branches, they will be lost (but retrievable through git reflog):
@@ Line 472: / Line 474: @@
 Now get the branch from the contributor to your computer, by creating an aptly named branch, and then pulling the code from the contributor to this branch.
+<pre>
   git checkout -b name_of_branch_to_create
   git pull https://github.com/contributor_username/pioneer.git name_of_branch_user_has
+</pre>
 Now switch to your master, and merge it in, here we asume the branch you created was called "feature_branch"

@@ Line 509: / Line 509: @@
 Get the user's PR into a branch as usual:
+<pre>
    git checkout -b some_user-feature_branch master
    git pull https://github.com/some_user/pioneer.git feature_branch
+</pre>
 make your changes, now push:
+<pre>
    git push https://github.com/some_user/pioneer.git some_user-feature_branch:feature_branch
+</pre>
 === PR trick ===

@@ Line 9: / Line 9: @@
 On Linux, git is available in all distributions using the standard tools such as APT, yum or emerge. Since there is a wide range of file browsers and graphical environments, this tutorial limits itself to the command line interface.
-On Windows you have two options, [http://msysgit.github.com/ Git for Windows] aka msysgit, or [http://windows.github.com/ Github for Windows] which is essentially msysgit but with some extra stuff bundled. Some of which is good ([https://github.com/dahlbyk/posh-git posh git]) and some of which is well, not (github's 'friendly' gui). Since both include the same command line tools and cross platform gui tools, either is fine for our purposes here. The github one may be more convenient to install.
+On Windows you have two options, [https://gitforwindows.org/ Git for Windows], or [http://windows.github.com/ Github for Windows] which is essentially msysgit but with some extra stuff bundled. Some of which is good ([https://github.com/dahlbyk/posh-git posh git]) and some of which is well, not (github's 'friendly' gui). Since both include the same command line tools and cross platform gui tools, either is fine for our purposes here. The github one may be more convenient to install.
 On Mac OS X, git will have been installed with XCode as git is built into the XCode IDE. However, usage of git from from within an IDE isn't something I'm familiar with so isn't covered here. If you want to follow along with this document then if you elected to install the XCode command line tools, then the git commands below should work unaltered from a terminal window. If you didn't then you'll need to use <code>xcrun</code> to run the commands in terminal, either by adding <code>xcrun</code> in front of each of the commands or aliasing <code>git</code> and <code>gitk</code> to <code>xcrun git</code> and <code>xcrun gitk</code> in your <code>~/.profile</code>. Have a look at [http://www.cocoanetics.com/2012/07/you-dont-need-the-xcode-command-line-tools/ this guide] for details.

@@ Line 217: / Line 217: @@
   git checkout master
   git fetch --all
-  git reset --hard upstream/hard
+  git reset --hard upstream/master
 or if you want to reset your branch <code>my-branch</code> to how it looks in your github

@@ Line 263: / Line 263: @@
 == Making a pull request ==
-Make a branch, push it to your Github repository, and you will get a "Compare / Open Pull Request" button when viewing your branch on your Github account if logged in. Press it, and write a description of the changes you've made. Mention what improves by the changes made in the pull request. (For more, see github documentat [https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork here]).
+Make a branch, push it to your Github repository, and you will get a "Compare / Open Pull Request" button when viewing your branch on your Github account if logged in. Press it, and write a description of the changes you've made. Mention what improves by the changes made in the pull request. (For more, see github documentat [https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork here]). Also see [https://www.atlassian.com/git/tutorials/making-a-pull-request this tutorial].
 == Fixing/Updating your pull request ==

← Older revision		Revision as of 17:25, 28 September 2020
Line 367:		Line 367:

	(again assuming your local branch is tracking the Github repo)		(again assuming your local branch is tracking the Github repo)
		+
		+	=== Resolving Merge Conflicts ===
		+
		+	Sometimes while you're working on a Pull Request other code will be merged into master that touches a file you've been working on. 90% of the time there's nothing you need to do, but occasionally git can't simply resolve the two changes and you'll need to manually update your code.
		+
		+	The easiest way to update your branch with the changes from master is called a "merge commit", where you merge in the changes from master to your local branch. '''DON'T DO THIS'''. It creates a messy history and makes it extremely difficult to review your pull request, as there's now two copies of those changes to the master branch.
		+
		+	Instead, please run a git rebase on your local branch to keep the pull request changes small and ensure it can be easily merged:
		+
		+	git fetch upstream master
		+	git rebase -i master

	== Getting other developer's branches ==		== Getting other developer's branches ==