Perform Final Review of the API before v1.0 Locks It

[whoisj]

All owners, collaborators, and interested parties should do a sweep of the API now, before v1.0 is reached and adjustments to the API become very burdensome to perform.

[whoisj]

/CC @jamill @nulltoken @ethomson @dahlbyk @Therzok @shiftkey

[nulltoken]

https://twitter.com/libgit2sharp/status/611258720010534913

[whoisj]

Awesome, I'm famous! 📷

[nulltoken]

You do deserve every little bit of fame 😉

[nulltoken]

/cc @spraints @KindDragon @suwatch

[nulltoken]

/cc @SimonCropp

[suwatch]

/cc @ahmelsayed

[ahmelsayed]

I've only used LibGit2Sharp briefly, but you guys are doing an amazing job 👍 Congratulations on v1

[spraints]

👍 from git-tfs, it's working well for us.

cc @pmiossec

[nulltoken]

Regarding #1093 (comment), how about:

• Move Submodule.RetrieveStatus() into SubmoduleCollection.RetrieveSubmoduleStatus()
• Turn SubmoduleStatus into a concrete type, which would expose IsUnmodified and IsWorkingDirectoryDirty shortcut properties along with another one which would maybe expose the flags? This may leave us some room for future improvement (conflicts, ...)

[dahlbyk]

Now that you mention it, I agree that the SubmoduleStatus API has some room for improvement (SRP violation, communicating both superproject and submodule status). Maybe open a specific issue to discuss?

[dahlbyk]

Should we unify tense? #964 (comment)

[whoisj]

Should we unify tense? #964 (comment)

That seems like a very reasonable thing. Mind opening an issue for it?

[whoisj]

I've added #1119 to look at the naming of our global structure.