libgit2 / libgit2/libgit2sharp

The road to 1.0 (or - at least - a stable API)

Open
#947 19 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
3.5k
Forks
925
PR merge metrics
No merged PRs in 30d

Description

We've discussed a stable API for some time, and we keep pushing back on a 1.0. I'd like to restart the discussion and try to list some action items on the things that we want to consider a "solid" API that we will guarantee.

Boring rationale:
We've been using LibGit2Sharp in Visual Studio and Team Foundation Server for a few years(!) now, with great success. So much, in fact, that we have about 10 independent groups on the VS and TFS teams using it. And of course we want to ship a single copy of LibGit2Sharp in the VS or TFS installer, so that means that all of these teams have to be on the same version.

This is becoming increasingly burdensome for us, because any time there's an API change, either the person updating LibGit2Sharp has to go and find all the people using it, fix them and hope it works or simply push it on up and put the build on the floor. (Usually the former, as it turns out that breaking the Visual Studio build is not a good career decision.)


/cc @jamill 

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are identified. Start by reading the issue discussion and inventorying the public LibGit2Sharp API and versioning concerns; done means reaching agreement on the stable API requirements and actionable follow-up items.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.