The API design on the wiki homepage seems to be outdated

Đang mở
#1,930 1 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
csharp, git
Lĩnh vực
documentation

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.

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

Ngôn ngữ chính
C#
Star
3.5k
Fork
925
Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của libgit2/libgit2sharp

Tất cả issue của libgit2/libgit2sharp

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.