From eqqon

Revision as of 16:48, 11 October 2009 (view source) Henon (Talk | contribs) (→News) ← Older edit		Revision as of 19:50, 11 October 2009 (view source) Henon (Talk | contribs) (→Motto) Newer edit →
Line 251:		Line 251:
	;Brain: Come, Pinky we need to get back to the lab and prepare for tomorrow night.		;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?		;Pinky: But why, Brain? What are we going to do tomorrow night?
-	;Brain: Try to get '''Git#''' done!!	+	;Brain: The same thing we do every night, Pinky. Try to get '''Git#''' done!!

---

Revision as of 19:50, 11 October 2009

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.

Status of the Project

Porting from JGit is done. We still need to implement most of the command line interface (git.exe).

Development Status

• GitSharp.Core (equivalent to jgit) - Beta
• GitSharp.CLI (git.exe) - Alpha
• GitSharp (a user friendly api) - Alpha

Test Summary

As of October, 8th 2009 on Windows

1105 passed | 6 failed | 1111 total tests

For more details on the tests, see our integration server.

Porting Status

As of October the 8th, 2009

Porting is complete. Future jgit commits will be tracked and ported on a regular basis.

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.
• See what work is open and allocate it at our collaboration spreadsheet. Request edit rights on the ML.
• 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

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 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 represents the currently tracked jgit version that has been ported into GitSharp.Core.

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

Compatibilty Issues

We are striving for maximum compatitbility of GitSharp against the original Git. However there are some differences that can not be avoided.

Platform Issues

• git clone with hard links is not supported on Windows.

Implementation Issues

There is a long list of not implemented features. They will be listed here later.

File a Bug Report

Please file any bugs at git# issue tracker. Please always specify the release version number or the commit hash of the actual GitSharp version you are using when reporting bugs.

Screenshots

Demo repository browser

GitSharp.Demo is a small repository browser project that should demonstrate the use of the GitSharp library. Get the sources at github.

It shows how to

• open a repository
• get the branches and tags
• get the commit history for a branch or tag
• recursive into the tree of a commit
• get the contents of a single file in a commit's tree (this commit's version of the file)
• get the changes between two commits (see screenshot of the diff viewer)

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.

Thanks

Many thanks go to ...

• Linus Torvalds 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

The same thing we do every night, Pinky. Try to get Git# done!!