Versioning policy and numbered deprecations before 1.0.0
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ó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- 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
- Sôi nổi
- Công nghệ
- javascript
- Lĩnh vực
- developer-experience
Hướng nghiên cứu
Start with PRODUCT.md, then inspect the versioning, upgrading, contribution, and agent guidance documents named in the issue, along with open issue #478. The issue defines the policy but leaves substantial research and implementation across documentation, deprecation tooling, tests, and package release processes. Done means the policy, numbered deprecation workflow and register, guidance, and pre-1.0 breaking change review are complete; first check how Node.js, Kubernetes, and Angular handle deprecations.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Before pivotkit goes to 1.0.0, I want a written versioning policy and the means to keep it. The goal: someone who merges minor and patch releases automatically never gets a break without warning.
Policy (decided)
- Semantic Versioning, strictly, from 1.0.0. Patch: fixes only. Minor: additions; what is to go away is only deprecated. Major: the only place where deprecated things are removed.
- One documented exception: a security fix may close an unsafe default in a minor or patch release, marked "Security" in the release notes, with detection and a way back.
- 0.x stays as it is: under active development, a minor can break, and every break is listed on the upgrading page. We still break as little as possible.
- All packages start 1.0.0 together.
Work
-
docs/versioning.md: the policy and the list of what counts as public interface (view file format, JS exports, REST/OpenAPI, MCP tool names and schemas, CLI flags, config keys, environment variables, error codes) and what does not (look and CSS details, message wording, internal modules, xlsx layout beyond the values). - Numbered deprecations: each gets an id
PK-DEP-NNNN, a runtime warning, acheck-configline, an entry on the upgrading page with the replacement, and a register in the docs. Removal no earlier than the next major. - Where possible, old input keeps working (translated to the new form) until the major.
- CONTRIBUTING.md and AGENTS.md: how to deprecate (code, test, register, upgrading page).
- Check open issues for pending breaking changes before 1.0.0 (for example #478).
- Verify how comparable projects do it (Node.js
DEPcodes, Kubernetes and Angular deprecation policies) and adopt what fits.
PRODUCT.md states the short promise and links here.
- Ngôn ngữ chính
- JavaScript
- Star
- 1
- Fork
- 1
- Merge trung bình
- 3 giờ 34 phút
- Pull request đã merge (30 ngày)
- 213
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Có mẫu pull request
- Đọc 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.
Issue khác của eizedev/pivotkit
-
area:server enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
Maintainer thường phản hồi trong vòng 1 ngày
-
area:server bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 1 ngày
-
area:server enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 66/100
Maintainer thường phản hồi trong vòng 1 ngày
-
documentation idea
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
Maintainer thường phản hồi trong vòng 1 ngày
-
area:tests idea
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của eizedev/pivotkit
Issue tương tự
-
入群码过期Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 84/100
aliyun/ai-agent-handbook#29 · 1 bình luận ·
-
docs documentation need-triage SaaS
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 1 ngày
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
apache/cloudstack#14719 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
Maintainer thường phản hồi trong vòng 3 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
Maintainer thường phản hồi trong vòng 1 ngày