Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
  • ¿Algo no está bien?
#608 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
66/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
typescript
Área
documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
TypeScript
Estrellas
5
Forks
3
Merge medio
9 h 37 min
PR fusionados (30 d)
157

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de NEARBuilders/everything-dev

Todos los issues de NEARBuilders/everything-dev

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.