libgit2 / libgit2/libgit2sharp

The API design on the wiki homepage seems to be outdated

Aberta
#1,930 1 comentário 1 reação 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
C#
Estrelas
3.5k
Forks
925
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece pelo código de design da API na página inicial da wiki do libgit2/libgit2sharp e compare-o com a API do NuGet LibGit2Sharp v0.26.2. Compile o exemplo copiado no Visual Studio usando os pacotes informados, atualize o conteúdo da wiki para corresponder à API atual e confirme que o exemplo compila sem os erros reportados de métodos ausentes.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
csharp, git
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.