libgit2 / libgit2/libgit2sharp
The API design on the wiki homepage seems to be outdated
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 3.5k
- Forks
- 925
- PR merge metrics
- No merged PRs in 30d
Description
The API design shown at https://github.com/libgit2/libgit2sharp/wiki/Home was last updated in 2011 (commit 338eace3f55ebb22d787012923c219e7c9e03755). If one tries to use it as a guide/manual one will find that the compiler takes issue with several methods missing (for example repo.Commits.StartingAt). It seems like it needs to be updated to match the current code base.
Reproduction steps
- Open a new solution in Visal Studio Professional 2017.
- Download the libgit2sharp NuGet packages.
- Copy and paste the API design code from the wiki home page.
- Hit compile.
Expected behavior
The code compiles.
Actual behavior
Compilation errors due to missing methods and properties.
Version of LibGit2Sharp (release number or SHA1)
NuGet-packages:
- LibGit2Sharp v0.26.2
- LibGit2Sharp.NativBinaries v2.0.314
Operating system(s) tested; .NET runtime tested
.NET Framework 4.6.1
Computer:
Utgåva (Edition) Windows 10 Pro
Version 20H2
Installerad (Installed) 2021-09-01
OS-version 19042.1348
Gränssnitt (Interface) Windows Feature Experience Pack 120.2212.3920.0
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the API design code on the libgit2/libgit2sharp wiki homepage and compare it with the LibGit2Sharp v0.26.2 NuGet API. Compile the copied example in Visual Studio against the reported packages, update the wiki content to match the current API, and confirm that the example compiles without the reported missing-method errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, git
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100