libgit2 / libgit2/libgit2sharp
The API design on the wiki homepage seems to be outdated
還沒有人認領這個 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
- 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
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 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