GitSharp/Contributing - Revision history

Henon: /* File a Bug Report */

2010-01-07T22:54:58Z

File a Bug Report

← Older revision		Revision as of 22:54, 7 January 2010
Line 30:		Line 30:
	<br>		<br>
	== File a Bug Report ==		== File a Bug Report ==
-
-	~~<font color="red">Note: we changed issue tracker from github to code.google.com</font>~~

	Please file any bugs, requests or other feedback in our [http://code.google.com/p/gitsharp/issues/list issue tracker]. Specify the release version number or the commit hash of the actual GitSharp version you are using when reporting bugs.		Please file any bugs, requests or other feedback in our [http://code.google.com/p/gitsharp/issues/list issue tracker]. Specify the release version number or the commit hash of the actual GitSharp version you are using when reporting bugs.

Henon: /* How You can Contribute to the Project's Success */

2010-01-07T22:54:06Z

How <big>You</big> can Contribute to the Project's Success

← Older revision		Revision as of 22:54, 7 January 2010
Line 9:		Line 9:
	** [Medium] Pick one of the open tasks on the issue tracker and pursue it		** [Medium] Pick one of the open tasks on the issue tracker and pursue it
	** [Hard] Implement one of the missing command line commands		** [Hard] Implement one of the missing command line commands
-	** [Only for ~~Freaks~~] Implement (or port over from original git) a missing feature that not even jgit supports.	+	** [Only for hardened veterans :D] Implement (or port over from original git) a missing feature that not even jgit supports.

	If you are doing some coding make sure you get in touch with us. We can coordinate efforts and give you hints.		If you are doing some coding make sure you get in touch with us. We can coordinate efforts and give you hints.

Henon: /* Porting from JGit */

2009-11-02T18:54:26Z

Porting from JGit

← Older revision		Revision as of 18:54, 2 November 2009
Line 53:		Line 53:
	* Please '''do''' keep order of methods, properties,... in sync with the Java version. If you work with a refactoring tool, make sure to configure it accordingly to this recommendation.		* Please '''do''' keep order of methods, properties,... in sync with the Java version. If you work with a refactoring tool, make sure to configure it accordingly to this recommendation.
	* Please '''consider''' committing ''small and atomic change-sets'' (instead of committing all your changes at the end of the day) in order to ease reviewing, merging and cherry-picking. You will benefit from it next time you pull.		* Please '''consider''' committing ''small and atomic change-sets'' (instead of committing all your changes at the end of the day) in order to ease reviewing, merging and cherry-picking. You will benefit from it next time you pull.
-	* Check out the list of [[/Non Trivial Java To CSharp Conversions\|non-trivial Java to C# conversions]].	+	* Check out the list of [[GitSharp/Non Trivial Java To CSharp Conversions\|non-trivial Java to C# conversions]].
-	* Please make sure you base your porting work on the same version of the [http://github.com/henon/jgit/tree/master jgit code] as all other developers to avoid inconsistencies.	+	* Please make sure you base your porting work on the same version of the [http://github.com/henon/parallelip-jgit/tree/master jgit code] as all other developers to avoid inconsistencies. As soon as jgit a commit is ported over it will be pushed up to that repostiory.
-		+
-	~~<br>~~	+
-	~~;Clone from~~	+
-	~~{{code\|git://github.com/henon/~~jgit~~.git}}~~	+
-		+
-	~~This mirror of the original jgit code base represents the currently tracked jgit version~~ that ~~has been ported into GitSharp.Core~~.	+

Henon: /* Getting Started with Git, GitHub and Coding */

2009-10-29T08:48:29Z

Getting Started with Git, GitHub and Coding

← Older revision		Revision as of 08:48, 29 October 2009
Line 28:		Line 28:
	The typical collaborative workflow with git can be described like this: Fork the [http://github.com/henon/GitSharp repository] at github, clone into your local repo and start coding. When you are done with the task, push to your fork on github and send a pull-request to henon. After other contributor's commits have been applied to the main repository your fork needs to be updated by pulling from henon/GitSharp. If you are not familiar with this workflow read the [[Collaborative Github Workflow\|in-depth description with git commands]].		The typical collaborative workflow with git can be described like this: Fork the [http://github.com/henon/GitSharp repository] at github, clone into your local repo and start coding. When you are done with the task, push to your fork on github and send a pull-request to henon. After other contributor's commits have been applied to the main repository your fork needs to be updated by pulling from henon/GitSharp. If you are not familiar with this workflow read the [[Collaborative Github Workflow\|in-depth description with git commands]].

-	<br><br>	+	<br>
		+	== File a Bug Report ==
		+
		+	<font color="red">Note: we changed issue tracker from github to code.google.com</font>
		+
		+	Please file any bugs, requests or other feedback in our [http://code.google.com/p/gitsharp/issues/list issue tracker]. Specify the release version number or the commit hash of the actual GitSharp version you are using when reporting bugs.
		+
	== Short Contributor's How-To ==		== Short Contributor's How-To ==
	* Join the [http://groups.google.com/group/gitsharp/ mailing list] and if you like to discuss/ask things in realtime the IRC channel '''#GitSharp''' on freenode.		* Join the [http://groups.google.com/group/gitsharp/ mailing list] and if you like to discuss/ask things in realtime the IRC channel '''#GitSharp''' on freenode.

Henon: /* Collaborate! */

2009-10-29T08:46:47Z

Collaborate!

← Older revision		Revision as of 08:46, 29 October 2009
Line 13:		Line 13:
	If you are doing some coding make sure you get in touch with us. We can coordinate efforts and give you hints.		If you are doing some coding make sure you get in touch with us. We can coordinate efforts and give you hints.

-	== Collaborate! ==	+	== Let's Collaborate ==

	;Via the Mailing List:		;Via the Mailing List:

Henon: /* How You can Contribute to the Projects Success */

2009-10-29T08:46:12Z

How <big>You</big> can Contribute to the Projects Success

← Older revision		Revision as of 08:46, 29 October 2009
Line 1:		Line 1:
-	== How <big>You</big> can Contribute to the ~~Projects~~ Success ==	+	== How <big>You</big> can Contribute to the Project's Success ==
	A list of things you can do with increasing level of difficulty :)		A list of things you can do with increasing level of difficulty :)
	* Link to us!		* Link to us!

Henon: /* How You can Contribute to the Projects Success */

2009-10-29T08:45:01Z

How <big><big>You</big></big> can Contribute to the Projects Success

← Older revision		Revision as of 08:45, 29 October 2009
Line 9:		Line 9:
	** [Medium] Pick one of the open tasks on the issue tracker and pursue it		** [Medium] Pick one of the open tasks on the issue tracker and pursue it
	** [Hard] Implement one of the missing command line commands		** [Hard] Implement one of the missing command line commands
		+	** [Only for Freaks] Implement (or port over from original git) a missing feature that not even jgit supports.

	If you are doing some coding make sure you get in touch with us. We can coordinate efforts and give you hints.		If you are doing some coding make sure you get in touch with us. We can coordinate efforts and give you hints.

Henon: New page: == How You can Contribute to the Projects Success == A list of things you can do with increasing level of difficulty :) * Link to us! * Blog abut GitSharp * Try it out and give ...

2009-10-29T08:42:54Z

New page: == How <big>You</big> can Contribute to the Projects Success == A list of things you can do with increasing level of difficulty :) * Link to us! * Blog abut GitSharp * Try it out and give ...

New page

== How <big>You</big> can Contribute to the Projects Success ==
A list of things you can do with increasing level of difficulty :)
* Link to us!
* Blog abut GitSharp
* Try it out and give us Feedback. We appreciate it!
* Hack together small examples of usage and publish them
* Code: Fork from [http://github.com/henon/GitSharp henon/GitSharp] and ...
** [Easy] Write test cases for an untested API function. This way you get into the code really fast!
** [Medium] Pick one of the open tasks on the issue tracker and pursue it
** [Hard] Implement one of the missing command line commands

If you are doing some coding make sure you get in touch with us. We can coordinate efforts and give you hints.

== Collaborate! ==

;Via the Mailing List:
Feel free to join the [http://groups.google.com/group/gitsharp/ git# mailing list]

We will post status updates regularly to keep you informed about the project status.

;Via IRC:
Visit us on freenode in Channel #GitSharp

== Getting Started with Git, GitHub and Coding ==
If you never contributed to a github project or are a git newbie read the [[Collaborative Github Workflow]] guide.

The typical collaborative workflow with git can be described like this: Fork the [http://github.com/henon/GitSharp repository] at github, clone into your local repo and start coding. When you are done with the task, push to your fork on github and send a pull-request to henon. After other contributor's commits have been applied to the main repository your fork needs to be updated by pulling from henon/GitSharp. If you are not familiar with this workflow read the [[Collaborative Github Workflow|in-depth description with git commands]].

<br><br>
== Short Contributor's How-To ==
* Join the [http://groups.google.com/group/gitsharp/ mailing list] and if you like to discuss/ask things in realtime the IRC channel '''#GitSharp''' on freenode.
* See what work is open at the issue tracker.
* Please '''*do not* use github fork queue''', just [[Collaborative Github Workflow|pull from henon/GitSharp]] to get other's changes
* Feel free to include your copyright to the files you contributed something to
* When you feel like your contribution should go into the main branch (henon/GitSharp) then post on the ML.
* When you corrupted your fork read [[Fixing Corrupt Git Branch]]

<br>

== Porting from JGit ==

Porting of the core is done. As soon as there are new commits in jgit we are going to port them over. However, there is still a lot of work to do, i.e. port implementations of CLI commands from jgit/pgm or port unit tests from the original git to test the command line.

* Port small portions with few dependencies first and comment out code that is ported but can not yet compile due to missing dependencies.
* Please '''do not''' rename java classes, methods, constants etc. or else porting of dependent code will be more complicated and error prone. We are going to rename according to .NET conventions as soon as all code is ported.
* Please '''do''' keep order of methods, properties,... in sync with the Java version. If you work with a refactoring tool, make sure to configure it accordingly to this recommendation.
* Please '''consider''' committing ''small and atomic change-sets'' (instead of committing all your changes at the end of the day) in order to ease reviewing, merging and cherry-picking. You will benefit from it next time you pull.
* Check out the list of [[/Non Trivial Java To CSharp Conversions|non-trivial Java to C# conversions]].
* Please make sure you base your porting work on the same version of the [http://github.com/henon/jgit/tree/master jgit code] as all other developers to avoid inconsistencies.

<br>
;Clone from
{{code|git://github.com/henon/jgit.git}}

This mirror of the original jgit code base represents the currently tracked jgit version that has been ported into GitSharp.Core.