Skip to content

Latest commit

 

History

History
78 lines (52 loc) · 3.48 KB

README.md

File metadata and controls

78 lines (52 loc) · 3.48 KB
Raw

LibGit2Sharp

master azurepipelines master win master nix coverity

LibGit2Sharp brings all the might and speed of libgit2, a native Git implementation, to the managed world of .NET and Mono.

Prerequisites

  • Windows: .NET 4.6.1+
  • Linux/Mac OS X: Mono 5.4+

Online resources

Troubleshooting and support

  • Usage or programming related question? Post it on StackOverflow using the tag libgit2sharp
  • Found a bug or missing a feature? Feed the issue tracker
  • Announcements and related miscellanea through Twitter (@libgit2sharp)

Quick contributing guide

  • Fork and clone locally
  • Create a topic specific branch. Add some nice feature. Do not forget the tests ;-)
  • Send a Pull Request to spread the fun!

More thorough information available in the wiki.

Optimizing unit testing

LibGit2Sharp strives to have comprehensive and robust unit test suite to ensure the quality of the software and to assist new contributors and users who can use the tests as sample to jump start development. There are over one thousand unit-tests for LibGit2Sharp, this number will only grow as functionality is added.

You can do a few things to optimize running unit-tests on Windows:

  1. Set the LibGit2TestPath environment variable to a path in your development environment.
  • If the unit-test framework cannot find the specified folder at runtime, it will fall back to the default location.
  1. Configure your anti-virus software to ignore the LibGit2TestPath path.
  2. Install a RAM disk like IMDisk and set LibGit2TestPath to use it.
  • Use imdisk.exe -a -s 512M -m X: -p "/fs:fat /q /v:ramdisk /y" to create a RAM disk. This command requires elevated privileges and can be placed into a scheduled task or run manually before you begin unit-testing.

Authors

License

The MIT license (Refer to the LICENSE.md file)