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

Add guidance for package maintenance

Đang mở
  • Có gì không ổn?
#113 3 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ó
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
Ít trao đổi
Công nghệ
javascript
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng việc xem lại tài liệu hiện có dành cho contributor và hướng dẫn SemVer được liên kết, sau đó xác định nơi cần đặt hướng dẫn về bảo trì package. Bao quát template của module, việc versioning, changelog, kiểm thử prerelease, các loại dependency và các workflow local và CI được liệt kê trong issue. Công việc được xem là hoàn tất khi các chủ đề này được ghi lại rõ ràng cho contributor của package.

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

Mô tả

category-documentation github-migration-triaged team-wallet-framework wf-documentation

Cover topics like:

  • Use the module template
  • Follow SemVer
  • Changelog maintenance
  • Testing prerelease builds locally and on CI
    • e.g. yarn link or file:// for local, preview builds for CI
  • dependencies vs peerDependencies vs devDependencies

Notes:
This message was on Slack and should be included in the guidelines in some way:
PSA: There are two primary ways that we communicate changes we've make to our NPM packages to consumers. Changelogs are one of them, but we also use versions as a coarse indicator as well. I have seen several instances over time where a version for a released package was bumped in a way that either oversells or undersells the changes inside of that release. For instance:

  • Bumping the minor part of a version if new functionality was not being added, when only the patch should have been bumped
  • Bumping only the patch part of a version when new functionality was added, when the minor should have been bumped
  • Not bumping the major part of a version when breaking changes are introduced

As a reminder, we use SemVer to assign new versions for packages. I would recommend everyone read this when they get a chance, especially the "Why Use" section and the FAQ.

Ngôn ngữ chính
JavaScript
Star
88
Fork
43
Không có pull request nào được merge trong 30 ngày

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 MetaMask/contributor-docs

Tất cả issue của MetaMask/contributor-docs

Issue tương tự

Thêm issue về JavaScript

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.