The API design on the wiki homepage seems to be outdated

Ouverte
#1,930 1 commentaire 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
35/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
csharp, git
Domaine
documentation

Piste de recherche

Commencez par le code de conception de l’API sur la page d’accueil du wiki de libgit2/libgit2sharp et comparez-le à l’API NuGet de LibGit2Sharp v0.26.2. Compilez l’exemple copié dans Visual Studio avec les packages indiqués, mettez à jour le contenu du wiki pour qu’il corresponde à l’API actuelle et confirmez que l’exemple se compile sans les erreurs de méthodes manquantes signalées.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

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
  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

Langage dominant
C#
Étoiles
3.5k
Forks
925
Aucune PR mergée en 30 j

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de libgit2/libgit2sharp

Toutes les issues de libgit2/libgit2sharp

Issues similaires

Plus d'issues C#

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.