libgit2 / libgit2/libgit2sharp
The API design on the wiki homepage seems to be outdated
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- C#
- Star
- 3.5k
- Fork
- 925
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
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
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu với mã thiết kế API trên trang chủ wiki của libgit2/libgit2sharp và so sánh mã đó với API NuGet LibGit2Sharp v0.26.2. Biên dịch ví dụ đã sao chép trong Visual Studio dựa trên các gói được nêu, cập nhật nội dung wiki để phù hợp với API hiện tại và xác nhận rằng ví dụ biên dịch thành công mà không có các lỗi thiếu phương thức đã được báo cáo.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- csharp, git
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100