Collaborative Github Workflow - Revision history

Henon: /* An Alternative for Github's Network Graph */

2012-04-28T10:24:45Z

An Alternative for Github's Network Graph

← Older revision		Revision as of 10:24, 28 April 2012
Line 152:		Line 152:
	{{code\|gitk --all}}		{{code\|gitk --all}}

-	It provides the same information ~~than~~ the github network tree but is formatted differently. Anyway, it is the fastest way of getting a decent graph based visualization of the actual happenings of the project. Based on this overview you can better decide what to merge or not.	+	It provides the same information as the github network tree but is formatted differently. Anyway, it is the fastest way of getting a decent graph based visualization of the actual happenings of the project. Based on this overview you can better decide what to merge or not.

	== Non-linear coding: Working on multiple Topics ==		== Non-linear coding: Working on multiple Topics ==

Henon: /* Resolving Merge Conflicts */

2012-04-28T10:23:57Z

Resolving Merge Conflicts

← Older revision		Revision as of 10:23, 28 April 2012
Line 136:		Line 136:

	=== Resolving Merge Conflicts ===		=== Resolving Merge Conflicts ===
-	If you are expecting conflicts it is wise to remember the hash value of your current head (i.e. write the first 8 digits of the hash on a ~~peace~~ of paper). To get it fire up gitk which is very convenient for browsing through the history or type	+	If you are expecting conflicts it is wise to remember the hash value of your current head (i.e. write the first 8 digits of the hash on a piece of paper). To get it fire up gitk which is very convenient for browsing through the history or type
	{{code\|git show HEAD}}		{{code\|git show HEAD}}

Henon: /* Correcting errors that are already merged upstream */

2012-04-28T10:23:06Z

Correcting errors that are already merged upstream

← Older revision		Revision as of 10:23, 28 April 2012
Line 207:		Line 207:

	=== Correcting errors that are already merged upstream ===		=== Correcting errors that are already merged upstream ===
-	You can correct errors that made it into the main repository only by creating a new commit that reverts the changes by the ~~erroneous~~ commit. On the command line it is as easy as	+	You can correct errors that made it into the main repository only by creating a new commit that reverts the changes by the erranous commit. On the command line it is as easy as

	{{code\|git revert COMMITHASH}}		{{code\|git revert COMMITHASH}}

Henon: typos fixed

2012-01-10T21:08:58Z

typos fixed

← Older revision		Revision as of 21:08, 10 January 2012
Line 61:		Line 61:
	<br>		<br>
	;Commit Early and Commit Often		;Commit Early and Commit Often
-	When you are doing much coding, maybe refactoring a large code base or commenting source code you should keep in mind that other's are also modifying the same code base and that conflicts may arise. In order to make it easier for you and the ~~oters~~ to resolve such conflicts on a per-commit basis try to commit as often as possible and commit only small changes. Provide a meaningful message for every commit so that anyone reviewing the commit later knows from reading the message what the commit changes.	+	When you are doing much coding, maybe refactoring a large code base or commenting source code you should keep in mind that other's are also modifying the same code base and that conflicts may arise. In order to make it easier for you and the others to resolve such conflicts on a per-commit basis try to commit as often as possible and commit only small changes. Provide a meaningful message for every commit so that anyone reviewing the commit later knows from reading the message what the commit changes.

	For the beginner I'd suggest seperating unrelated changes on a file per file basis, although git allows much more fine-grained control over the changes to commit. Committing a selection of files can most conveniently be done in TortoiseGit. You can select the files that you want to commit, compare against the local repository what changes you made and comment your changes in the commit message. Of course it can also be done on the command line interface First stage all changes you want to commit by using git add.		For the beginner I'd suggest seperating unrelated changes on a file per file basis, although git allows much more fine-grained control over the changes to commit. Committing a selection of files can most conveniently be done in TortoiseGit. You can select the files that you want to commit, compare against the local repository what changes you made and comment your changes in the commit message. Of course it can also be done on the command line interface First stage all changes you want to commit by using git add.
Line 133:		Line 133:
	Remember, pull is a combination of the commands fetch and merge, so there may be merge conflicts to be manually resolved. The most confortable way to resolve conflicts is to use TortoiseGit's '''edit conflicts''' tool.		Remember, pull is a combination of the commands fetch and merge, so there may be merge conflicts to be manually resolved. The most confortable way to resolve conflicts is to use TortoiseGit's '''edit conflicts''' tool.

-	If you need to integrate with ~~annother~~ developer but his commits have not yet been merged upstream just merge his branch directly.	+	If you need to integrate with another developer but his commits have not yet been merged upstream just merge his branch directly.

	=== Resolving Merge Conflicts ===		=== Resolving Merge Conflicts ===

Henon: /* Resolving Merge Conflicts */

2010-01-22T18:27:00Z

Resolving Merge Conflicts

← Older revision		Revision as of 18:27, 22 January 2010
Line 139:		Line 139:
	{{code\|git show HEAD}}		{{code\|git show HEAD}}

-	If you want to undo the merge you can just go back by resetting hard to that hash as described in '''Something Went Wrong'''. If you are getting many conflicts it means you should have merged your branch with the main line more often. To resolve the conflicts use TortoiseGit, start the commit-Dialog, right click on the red files and choose "Edit conflicts". After editing the conflicting lines (marked red) click on the "Resolved"-Button. After you resolved all ~~conflicting files~~ commit and push.	+	If you want to undo the merge you can just go back by resetting hard to that hash as described in '''Something Went Wrong'''. If you are getting many conflicts it means you should have merged your branch with the main line more often. To resolve the conflicts use TortoiseGit, start the commit-Dialog, right click on the red files and choose "Edit conflicts". After editing the conflicting lines (marked red) click on the "Resolved"-Button.
		+
		+	Important: After you resolved all conflicts '''don't forget to commit''' and push.

	=== An Alternative for Github's Network Graph ===		=== An Alternative for Github's Network Graph ===

Henon: /* Getting Started */

2009-09-19T16:08:20Z

Getting Started

← Older revision		Revision as of 16:08, 19 September 2009
Line 71:		Line 71:
	{{code\|git add -i}}		{{code\|git add -i}}

-	~~Committing on the command line:~~	+	Now check if everything has been added or if you missed something
-	{{code\|git ~~commit -m"The commit message"~~}}	+	{{code\|git status}}
-		+
-	~~Or, if you like to commit all your changes without explicitly staging them~~	+

		+	Committing on the command line (btw, never forget -a):
	{{code\|git commit -a -m"The commit message"}}		{{code\|git commit -a -m"The commit message"}}

Henon: /* Resolving Merge Conflicts */

2009-09-19T15:31:37Z

Resolving Merge Conflicts

← Older revision		Revision as of 15:31, 19 September 2009
Line 140:		Line 140:
	{{code\|git show HEAD}}		{{code\|git show HEAD}}

-	If you want to undo the merge you can just go back by resetting hard to that hash as described in '''Something Went Wrong'''. If you are getting many conflicts it means you should have merged your branch with the main line more often. To resolve the conflicts use TortoiseGit, start the commit-Dialog, right click on the red files and choose "Edit conflicts". After editing the conflicting lines (marked red) click on the "Resolved"-Button. After you resolved all ~~conflicts~~ commit and push.	+	If you want to undo the merge you can just go back by resetting hard to that hash as described in '''Something Went Wrong'''. If you are getting many conflicts it means you should have merged your branch with the main line more often. To resolve the conflicts use TortoiseGit, start the commit-Dialog, right click on the red files and choose "Edit conflicts". After editing the conflicting lines (marked red) click on the "Resolved"-Button. After you resolved all conflicting files commit and push.

	=== An Alternative for Github's Network Graph ===		=== An Alternative for Github's Network Graph ===

Henon: /* Keeping Your Fork Up-To-Date */

2009-09-19T15:24:51Z

Keeping Your Fork Up-To-Date

← Older revision		Revision as of 15:24, 19 September 2009
Line 124:		Line 124:
	{{code\|git remote add henon git://github.com/henon/GitSharp.git}}		{{code\|git remote add henon git://github.com/henon/GitSharp.git}}

-	Make sure your repository is clean and is currently on the master branch. If not, commit or stash any changes and switch to the master:	+	Make sure your repository is clean (no uncommitted changes) and is currently on the master branch. If not, commit or stash any changes and switch to the master:

	{{code\|git checkout master}}		{{code\|git checkout master}}
Line 136:		Line 136:
	If you need to integrate with annother developer but his commits have not yet been merged upstream just merge his branch directly.		If you need to integrate with annother developer but his commits have not yet been merged upstream just merge his branch directly.

-	=== Github's Network Graph ~~is Slow~~ ===	+	=== Resolving Merge Conflicts ===
		+	If you are expecting conflicts it is wise to remember the hash value of your current head (i.e. write the first 8 digits of the hash on a peace of paper). To get it fire up gitk which is very convenient for browsing through the history or type
		+	{{code\|git show HEAD}}
		+
		+	If you want to undo the merge you can just go back by resetting hard to that hash as described in '''Something Went Wrong'''. If you are getting many conflicts it means you should have merged your branch with the main line more often. To resolve the conflicts use TortoiseGit, start the commit-Dialog, right click on the red files and choose "Edit conflicts". After editing the conflicting lines (marked red) click on the "Resolved"-Button. After you resolved all conflicts commit and push.
		+
		+	=== An Alternative for Github's Network Graph ===
	The network graph on github is a very handy tool (for both developers and maintainers) to see who has committed what to any fork recently. But unfortunately sometimes the graph has errors or you just need to wait hours for it. In this case you can do something else. Add the public clone urls of all relevant forks to your remote configuration as described above (using git remote add). Then you can download their commits without merging them:		The network graph on github is a very handy tool (for both developers and maintainers) to see who has committed what to any fork recently. But unfortunately sometimes the graph has errors or you just need to wait hours for it. In this case you can do something else. Add the public clone urls of all relevant forks to your remote configuration as described above (using git remote add). Then you can download their commits without merging them:

Henon: /* Non-linear coding: Working on multiple Topics */

2009-09-16T18:40:49Z

Non-linear coding: Working on multiple Topics

← Older revision		Revision as of 18:40, 16 September 2009
Line 148:		Line 148:

	== Non-linear coding: Working on multiple Topics ==		== Non-linear coding: Working on multiple Topics ==
-	~~If you are a git newbie you might want to skip this section and return later.~~

	TODO: describe working with topic branches		TODO: describe working with topic branches

Rolenun: /* Getting Started */

2009-08-29T02:14:16Z

Getting Started

← Older revision		Revision as of 02:14, 29 August 2009
Line 26:		Line 26:
	<br>		<br>
	;Fork:		;Fork:
-	Say you want to '''start contributing''' to a project on github. The first thing to do is to fork it on github. Forking is the preferred way of collaboration on github and it works quite well with git. Just follow the ~~instructions on~~ [http://github.com/guides/home ~~Github~~]. Now you should have your own public repository which contains exactly the same history as the main repository at the time you forked. You will later push your contributions into this repository and the maintainers of the main repository will pull your commits into the main branch.	+	Say you want to '''start contributing''' to a project on github. The first thing to do is to fork it on github. Forking is the preferred way of collaboration on github and it works quite well with git. Just follow the [http://github.com/guides/home instructions] on github. Now you should have your own public repository which contains exactly the same history as the main repository at the time you forked. You will later push your contributions into this repository and the maintainers of the main repository will pull your commits into the main branch.

	<br>		<br>