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

site: generate a changelog page and the README "Recent" block from docs/review-ledger.md

Abierto
  • ¿Algo no está bien?
#91 0 comentarios 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
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
52/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
javascript
Área
documentation, full-stack

Línea de trabajo

Read build.mjs, sync-counts.mjs, site/lib/markdown.mjs, and lib.test.mjs to understand the existing site build, rendering, and README update patterns. Then inspect docs/review-ledger.md, README.md, and ROADMAP.md to trace the source format and completion criteria. Done means /changelog/ is generated and linked, the README Recent block comes from the ledger, parser coverage is added, and the roadmap item is marked Done.

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

Descripción

documentation enhancement priority: medium

Why it matters
docs/review-ledger.md is a 1,300-line, well-structured record of every sweep, but it is invisible from the site and the README. The README's "Recent:" blockquote restates three of its entries by hand and will drift. A changelog page gives returning visitors a reason to come back, shows contributors what a good sweep looks like, and is already under "Planned" in ROADMAP.md.

Evidence

  • ROADMAP.md, Planned: "A changelog page generated from docs/review-ledger.md".
  • README.md ~lines 50-53, the hand-maintained "Recent:" block.
  • The ledger uses a strict shape (## YYYY-MM-DD (title) then bullets), so it parses with site/lib/markdown.mjs.

Suggested approach

  1. In build.mjs, split the ledger on ## date headings, render the newest N sections with the existing renderer, write dist/changelog/index.html with the shared page shell, and add it to the sitemap, footer and llms.txt.
  2. Have sync-counts.mjs (or a sibling step) rewrite the README "Recent:" block from the three newest ledger headings, the same way it rewrites counts, so it cannot drift.
  3. Optionally emit changelog.xml as a second Atom feed.

Done when
/changelog/ is live and linked, the README block is generated, lib.test.mjs covers the ledger parser, and the ROADMAP item moves to Done.

Lenguaje dominante
JavaScript
Estrellas
58
Forks
15
Merge medio
16 h 53 min
PR fusionados (30 d)
14

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 TMHSDigital/Free-Game-Dev-Assets

Todos los issues de TMHSDigital/Free-Game-Dev-Assets

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.