libgit2 / libgit2/libgit2sharp

The API design on the wiki homepage seems to be outdated

Offen
#1,930 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
C#
Sterne
3.5k
Forks
925
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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
  1. Open a new solution in Visal Studio Professional 2017.
  2. Download the libgit2sharp NuGet packages.
  3. Copy and paste the API design code from the wiki home page.
  4. 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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit dem API-Design-Code auf der Wiki-Homepage von libgit2/libgit2sharp und vergleichen Sie ihn mit der LibGit2Sharp v0.26.2 NuGet-API. Kompilieren Sie das kopierte Beispiel in Visual Studio gegen die angegebenen Pakete, aktualisieren Sie den Wiki-Inhalt, sodass er der aktuellen API entspricht, und bestätigen Sie, dass das Beispiel ohne die gemeldeten Fehler wegen fehlender Methoden kompiliert.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp, git
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.