Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

docs: reconcile CONTRIBUTING.md and orphaned CHANGELOGs with changesets scoping (#572)

オープン
  • 何か問題がありますか？
#608 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
66/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
typescript
領域
documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

documentation ready-for-agent

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-dev means "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.md
  • plugins/{_template,ai,auth,proposals,registry,votes}/CHANGELOG.md
  • apps/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.

主要言語
TypeScript
スター
5
フォーク
3
平均マージ
9時間 50分
マージ済み PR（30日）
146

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

NEARBuilders/everything-dev のほかの issue

NEARBuilders/everything-dev の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。