docs: reconcile CONTRIBUTING.md and orphaned CHANGELOGs with changesets scoping (#572)
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
- 66/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- typescript
- Lĩnh vực
- documentation
Hướng nghiên cứu
Read CONTRIBUTING.md, scripts/changeset-guard.mjs, and the listed CHANGELOG.md files; check package metadata to confirm which packages are publishable. Update the Changesets guidance and normalize commands to pnpm, then delete only the specified private-workspace changelogs. Done when the docs match the guard and release flow, and publishable package changelogs remain.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Context
#605 (changesets scoped to publishable packages, release-capture rule from #572) left two doc surfaces stale. The rules themselves are right — content-addressed deploys make private-workspace versioning dead weight — but the contributor-facing docs now contradict the CI guard, and frozen changelog files will mislead forever.
Task 1 — Rewrite the CONTRIBUTING.md Changesets section
CONTRIBUTING.md lines ~120–148 still teach the exact format the new CI guard (scripts/changeset-guard.mjs) rejects:
- The example changeset targets
"api": minor/"ui": patch— private workspaces, now hard-failed by the guard. - "On merge of that PR, GitHub releases are created for api/ui" is false — releases are for the publishable framework packages (
every-plugin,everything-dev,better-near-auth). - The release-capture rule is absent: a changeset against
everything-devmeans "cut a release including everything merged so far"; small changes ride continuous deploys.
Rewrite to: publishable-packages-only, the release-capture rule, guard behavior, corrected example ("everything-dev": minor), corrected release flow (npm publish under rc dist-tag + GitHub Releases; deploys are content-addressed, not version-gated).
Task 2 — Delete orphaned private-workspace CHANGELOG.md files
Frozen at the last version PR (7fade711, rc #564); nothing will ever append to them again. Delete:
api/CHANGELOG.md,host/CHANGELOG.md,ui/CHANGELOG.mdplugins/{_template,ai,auth,proposals,registry,votes}/CHANGELOG.mdapps/upload/CHANGELOG.md
Keep packages/*/CHANGELOG.md (publishable, changesets-maintained).
Why it matters beyond tidiness: INIT_ROOT_PATTERNS copies host/**, ui/**, and plugins/<dir>/** into new child projects (packages/everything-dev/src/services/scaffold/init.ts:155), so _template/host/ui changelogs currently scaffold stale files into every new child.
Task 3 — Normalize bun → pnpm in CONTRIBUTING.md
The repo standardizes on pnpm (AGENTS.md, CI, root scripts), but CONTRIBUTING.md uses bun install / bun run changeset / bun typecheck / bun lint throughout.
Sequencing
- Land after #605 merges (the guard ships on its branch).
- No conflict with #600 (disjoint files).
Out of scope (separate consideration)
Generated release notes from git history (e.g. git-cliff) in the GitHub Release body — a "what changed" surface between releases, without reintroducing per-package changesets.
- Ngôn ngữ chính
- TypeScript
- Star
- 5
- Fork
- 3
- Merge trung bình
- 9 giờ 32 phút
- Pull request đã merge (30 ngày)
- 152
Chuẩn bị môi trường
- Có Dockerfile hoặc tệp Docker Compose
- Không 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 NEARBuilders/everything-dev
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 77/100
NEARBuilders/everything-dev#628 · 1 bình luận ·
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 78/100
NEARBuilders/everything-dev#400 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 45/100
NEARBuilders/everything-dev#636 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 57/100
NEARBuilders/everything-dev#635 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 45/100
NEARBuilders/everything-dev#634 ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của NEARBuilders/everything-dev
Issue tương tự
-
category::task code priority::normal
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
e0ipso/strikethroo#145 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 85/100
cocos/cocos-docs#3333 ·
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
RevenueCat/react-native-purchases#2079 ·
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 78/100
RevenueCat/purchases-hybrid-common#2039 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
agent-reported area/react bug
Độ 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 1 ngày