Lack of documentation

[basickarl]

What happens if git is not installed or that perhaps you are in a directory where git doesn't exist? What happens? What happens if the user isn't setup yet? etc.etc.etc.

[rwjblue]

Would love help documenting where you see things are missing.

RE: your specific questions:

What happens if git is not installed

This library does not rely on git executable, and git does not need to be installed at all.

you are in a directory where git doesn't exist?

I think if you execute in a directory that doesn't contain a .git subdirectory, it will error.

What happens if the user isn't setup yet?

Since we don't execute git at all, I don't think the user setup matters at all.

[basickarl]

@rwjblue Ah ok, so it comes with it nice! Yea these things would be good to add to the documentation!

Ah yes true, if you use a username/password when pushing git will obviously use that account in the repo!

[ctsstc]

@basickarl this does not use git to my knowledge, this uses the metadata stored in the files under the .git directory. Simple file parsing can be used to extract the state & information without the system needing to have git installed. It is also not included as a dependency in this package to my knowledge either.

[rwjblue]

ya, exactly