libgit2 / libgit2/libgit2sharp

The API design on the wiki homepage seems to be outdated

未关闭
#1,930 1 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
C#
星标
3.5k
派生
925
PR 合并指标
30 天内没有已合并 PR

描述

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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 libgit2/libgit2sharp wiki 主页上的 API 设计代码开始,并将其与 LibGit2Sharp v0.26.2 NuGet API 进行比较。使用报告的包在 Visual Studio 中编译复制的示例,更新 wiki 内容以匹配当前 API,并确认该示例在没有报告的缺少方法错误的情况下能够编译。

由索引模型根据 Issue 内容生成。

评估

技术栈
csharp, git
领域
documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。