Feel free to add common problems with their solutions here, or just anything that wasn't clear at first.

As seen in nodegit/#959 -- some golang hackers have started to use the following stanza in .gitconfig to allow `go get` to work with private repos:

But if you do this, code can call `NodeGit.Clone.clone(url: 'https://foo')` and have the `authentication` callback be asked for **SSH** credentials instead of HTTPS ones, which might not be what your application expected.

**Stable (libgit2@v0.28.3): 0.28.3**

Visit [slack.libgit2.org](http://slack.libgit2.org/) to sign up, then join us in #nodegit.

Tyler Ang-Wanek [@twwanek](http://twitter.com/twwanek) with help from tons of

[awesome contributors](https://github.com/nodegit/nodegit/contributors)!

Tim Branyen [@tbranyen](http://twitter.com/tbranyen),

John Haley [@johnhaley81](http://twitter.com/johnhaley81),

Max Korp [@maxkorp](http://twitter.com/MaximilianoKorp),

Steve Smith [@orderedlist](https://twitter.com/orderedlist),

Michael Robinson [@codeofinterest](http://twitter.com/codeofinterest), and

Nick Kallen [@nk](http://twitter.com/nk)

NodeGit will work on most systems out-of-the-box without any native

dependencies.

npm install nodegit

In Ubuntu:

sudo add-apt-repository ppa:ubuntu-toolchain-r/test

sudo apt-get update

sudo apt-get install libstdc++-4.9-dev

In Travis:

addons:

apt:

sources:

You will need the following libraries installed on your linux machine:

When building locally, you will also need development packages for kerberos and pcre, so both of these utilities must be present on your machine:

If you are still encountering problems while installing, you should try the

[Building from source](http://www.nodegit.org/guides/install/from-source/)

instructions.

// Look up this known commit.

// Use a known commit sha from this repository.

})

// Look up a specific file within that commit.

})

// Get the blob contents from the file.

// Patch the blob to contain a reference to the entry.

blob.entry = entry;

return blob;

});

})

// Display information about the blob.

// Show the path, sha, and filesize in bytes.

// Show a spacer.

// Show the entire file.

console.log(String(blob));

})

// Open the master branch.

return repo.getMasterCommit();

})

// Display information about commits on master.

// Create a new history event emitter.

var history = firstCommitOnMaster.history();

// Create a counter to only show up to 9 entries.

var count = 0;

// Listen for commit events from the history.

// Disregard commits past 9.

if (++count >= 9) {

return;

}

// Show the commit sha.

// Store the author object.

var author = commit.author();

// Display author information.

// Show the commit date.

// Give some space and show the message.

});

// Start emitting events.

For more examples, check the `examples/` folder.

npm test

This is a guide on how to contribute test cases to help with coverage testing for NodeGit.

Currently there are a number of fields and functions in NodeGit that have no tests at all. A list of which files are missing and what fields and functions need tests can be generated by running

npm run generateMissingTests

This will make the file `generate/output/missing-tests.json` which will contain info for tests or files that are currently missing.

From this file you can find fields and functions that don't have any tests yet and pick one to work on.

After you find a test that's missing the next step is to find or add the file that you need to add it into. You can always use other tests in the directory as a guide for writing more. All new files will be automatically added during a test run.

In the `missing-tests.json` file you'll see it formatted like so:

{

"fields": [],

"functions": []

}

After you write your test make sure to run `npm run generateMissingTests` again to confirm that the field/function that a test was written for no longer shows up.

Excellent!! Make sure that the test is working correctly and testing what you're expecting it to test and then move onto the [next section](#making-a-pull-request).

This is also great! You just found something that wasn't properly covered in our generate scripts for wrapping libgit2. We'll have to further analyze what's going on and figure out how to fix it.

For bonus points you could also include a fix in your pull request but that step is optional.

So you made your self a new test for NodeGit and now you want to add it to the main repo? That's great! We'll try and make the process as simple and easy as possible for you.