Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Document the versioning scheme in the README: 2.0.x (stable) vs 3.0.0-preview, stale GitHub Releases, and v10/v11 tags

Đang mở
  • Có gì không ổn?
#2,813 2 bình luận 13 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

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
55/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
csharp
Lĩnh vực
cli, documentation

Hướng nghiên cứu

Bắt đầu với README của repository và readme của gói NuGet, sau đó đối chiếu các nhận định được đề xuất về versioning với dotnet/dotnet VMR, các phiên bản NuGet, GitHub Releases và các tag v10.x/v11.x được tham chiếu. Xác nhận các nhánh release liên quan và các thread trước đây (#1251, #2500, #2576) trước khi ghi lại các phiên bản stable và preview, lịch sử release và ý nghĩa của các tag; hoàn tất khi hướng dẫn chính xác và nhất quán trong cả hai readme.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

As a consumer it's currently very hard to reason about which version to use and what changed between versions, because the four places I'd look all disagree:

  • NuGet shows 2.0.8 (latest stable) and 3.0.0-preview.4.*.
  • GitHub Releases is frozen — newest entry is v2.0.2 (Jan 2026); 2.0.3–2.0.8 and all 3.0.0 previews shipped with no release and no notes.
  • Git tags carry SDK-band versions: the same commit c7b5e07c is tagged v2.0.1, v2.0.2, v2.0.3, and v10.0.4/v10.0.5/v10.0.104/v10.0.105; 702b2bbd is tagged v11.0.0/v11.0.100. Meanwhile NuGet 2.0.4/2.0.5/2.0.6 have no tags at all.
  • There's no curated CHANGELOG.

My understanding (please correct): since the source moved into the dotnet/dotnet VMR around 2.0.0-beta6, releases are produced by the central .NET build, the git tags follow .NET SDK bands rather than the package version, and GitHub Releases is no longer the source of truth. If that's right, it would help enormously to state it in the README so people stop re-deriving it.

Ask: add a short "Versioning" section to the README (and ideally the NuGet package readme) answering:

  1. Which version do I use? (2.0.x = stable; what's 3.0.0-preview?)
  2. Why is GitHub Releases stale, and what should I look at instead for a changelog?
  3. What are the v10.x/v11.x tags and can I ignore them?

Suggested starting text (happy to open a PR once the facts are confirmed):

## Versioning

`System.CommandLine` is built and released as part of the .NET product (the
dotnet/dotnet VMR); this repo is a mirror. Use **NuGet** as the source of truth:

- **`2.0.x`** — current stable line (ships with .NET 10). Recommended for production.
- **`3.0.0-preview.x`** — in-development line (.NET 11).

GitHub Releases and the `v10.x`/`v11.x` git tags reflect the .NET build/SDK
versioning, not the NuGet package version — for change history, compare the
relevant release branch (`release/10.0` for 2.0.x, `main` for 3.0) on GitHub.

Related prior threads: #1251, #2500, #2576.

Ngôn ngữ chính
C#
Star
3.7k
Fork
434
Merge trung bình
6 giờ 27 phút
Pull request đã merge (30 ngày)
2

Chuẩn bị môi trường

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 dotnet/command-line-api

Tất cả issue của dotnet/command-line-api

Issue tương tự

Thêm issue về C#

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.