SemVer policy + MSRV

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

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

Đánh giá

Độ khó
1/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
44/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ệ
rust
Lĩnh vực
documentation

Hướng nghiên cứu

Read the existing MSRV sections in README.md and the linked Rust API Guidelines discussion to understand the proposed policy. Replace those sections with a SemVer Policy section that states how MSRV changes are treated; done means the README gives contributors a clear policy to reference. The issue has had no activity for over a year, so check whether the policy is still wanted before starting.

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

Mô tả

Coming from https://github.com/RustCrypto/password-hashes/issues/627

I think it would make sense to replace the old MSRV sections of our README.md with a new "SemVer Policy" section which lists MSRV as being out-of-scope, possibly highlighting https://github.com/rust-lang/api-guidelines/discussions/231

Without it, I worry people will say MSRV changes are a breaking change (even if that's wrong), so it would be nice to have something to point to in the README saying MSRV changes don't violate our SemVer policy.

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
13
Fork
4
Merge trung bình
41 phút
Pull request đã merge (30 ngày)
1

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 RustCrypto/meta

Tất cả issue của RustCrypto/meta

Issue tương tự

Thêm issue về Documentation

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.