From eqqon

(Difference between revisions)

Jump to: navigation, search

Revision as of 11:53, 17 September 2009

Agreed, git support on Windows could be better ...

... want to improve the situation?

Contribute to Git#, the most advanced open source implementation for .NET

Every little bit helps:

Link to the Git# website to promote the project.
Tell your friends ...
Code! Tackle some of the un-ported jgit classes or unit tests.

So let's all stop complaining about the situation, start rocking and have fun!

What is Git?

Git is a free & open source, distributed version control system designed to handle everything from small to very large projects with speed and efficiency. Git was initially designed and developed by Linus Torvalds for Linux kernel development.

Every Git clone is a full-fledged repository with complete history and full revision tracking capabilities, not dependent on network access or a central server. Branching and merging are fast and easy to do.

Git is used for version control of files, much like tools such as Mercurial, Bazaar, Subversion, CVS, Perforce, and Visual SourceSafe.

Git's key characteristics make it stand out against the other SCM tools:

Strong and efficient support for non-linear development
Distributed development
Multiple protocol support such as HTTP, FTP, ssh, rsync, etc.
Efficient handling of large projects
Pluggable merge strategy

Popularity

According to a survey by the git community it is rapidly gaining more users. This is a graph of the survey results :

(borrowed from Mauricio Scheffer)

Git# --> Git for .NET and Mono

... a native Windows version of the fast & free open source version control system

GitSharp is the most advanced CSharp implementation for the .NET framework and Mono. It is aimed to be fully compatible to the original git and shall be a light weight library for cool applications that are based on git as their object database or are reading or manipulating repositories in some way.

What you could do with Git#

Git# as object oriented interface to your git repo: Want to manipulate you git repo from C#? Want to calculate statistics or create a beautiful visualization? Use git#'s well designed object oriented API to access and manipulate repositories.

Git# as object database: Git is an object database with built-in history and branching. If you need to create snapshots of your application's configuration or your user's data with alternative configuration branches then use git. By moving the HEAD in the repository you can easily implement undo/redo operations. For instance, one could build a wiki on top of git# or a distributed content management system. Write-support is already implemented so you could already give it a try.

Git# as (distributed) file system: Git has been designed by Linus Thorwalds to be a file system that is very good at content-tracking and keeping multiple distributed versions of the same content in sync. If your application needs to implement backup and/or content synchronization routines then it can build on top of git to do that. (We still need to implement remote transport for this.)

Git# as peer-to-peer content distribution system: If you need to build a content distribution framework that will easily and efficiently transport content to different machines then you can easily build one on top of git. (We still need to implement remote transport for this.)

Git# as a future replacement of msysGit?: msysGit currently is the most complete and usable native provider for git on Windows. The problem with msysGit is, that it can not be easily extended by or embedded in other applications. Apart from being a lightweight library, in the future git# might also become a real alternative to msysGit but we are still far away from that.

News

August 25th, 2009: Jim Radford added git# at his TeamCity integration server. We now have automatic builds on both, Windows and Mono. Since the other TeamCity account does not support Mono it can now be viewed as a code mirror ;)
August 15th, 2009: Dan Rigby created the IRC channel #GitSharp on freenode. It's a nice place to chat a little or ask questions about git.
July 2nd, 2009: Mauricio Scheffer has set up git# on the build and integration service teamcity.codebetter.com
July 1st, 2009: Writing of blobs, trees and commits works
June 15th, 2009: Reading of commit history, trees, blobs and tags works. See the demo browser screenshot below.

Status of the Project

Development Status: Pre-Alpha, "fast-forward" =P, still need to port large portions of java code. Wanna help?

Watch the commit history on github to keep informed!

Test Summary

As of September the 17th 2009 on Windows

1020 passed | 17 failed | 1037/1280 total tests ported to C#

Porting Status

As of September the 7th, 2009: 22375 of 26041 lines of code are ported => 86% complete (without counting comments, lines with less than three chars and tests)

Get the Source Code

public clone url: git://github.com/henon/GitSharp.git

Contributing

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 repository at github clone 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 in-depth description with git commands.

Never mind, if you haven't got the time to do some coding. Promoting the project and giving feedback are also most valuable contributions.

Short Contributor's How-To

Join the mailing list and if you like to discuss/ask things in realtime the IRC channel #GitSharp on freenode.
Please *do not* use github fork queue, just 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

Porting from JGit --> clone git://github.com/henon/jgit.git

Note: We are recently migrating from an older jgit version to the jgit version 5c484fc. Check out the Mailing list for updates.

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.
Check out the list of non-trivial Java to C# conversions.
Please make sure you base your porting work on the same version of the jgit code as all other developers to avoid inconsistencies.

Clone from

git://github.com/henon/jgit.git

This mirror of the original jgit code base is used to coordinate the base from which everyone is porting. The current jgit commit we are based on is

Commit 5c484fc83458219a34c3fb4c3f12befb6983e821

Author: Jonas Fonseca <fonseca@diku.dk>

Date: Wed Aug 19 08:50:59 2009 -0400

Changes after that commit can easily be tracked later by applying the differences between this and the newer jgit version. Rebasing on a newer jgit version will be announced on the mailing list and the jgit mirror henon/jgit will be updated for you.

Collaborate!

Via the Mailing List

Feel free to join the 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

File a Bug Report

Please file any bugs at git# issue tracker.

Screenshots

Demo repository browser

Wpf test browser GitSharp.Demo

License

Git# is derived from the Java library jgit and is released under the BSD license like jgit.

Please refer to the LICENSE.txt files for the complete license, and please refer to the individual source file header to determine which license covers it and who contributed and therefor holds copyrights to the files.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the Git Development Community nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Thanks

Many thanks go to ...

Linus Thorvalds and the git community for creating and maintaining git.
Shawn O. Pearce and the jgit dev community. Git# is based on their excellent work.
All the people who contributed to git#

Motto

Brain: Come, Pinky we need to get back to the lab and prepare for tomorrow night.
Pinky: But why, Brain? What are we going to do tomorrow night?
Brain: Try to get Git# done!!

@@ Line 128: / Line 128: @@
 * 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.
 * 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.