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

docs: ROADMAP lists shipped work as planned and unreleased releases as done; the High-risk guide still speaks to maintainers

Abierto Apto para principiantes
#178 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
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
82/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
markdown

Línea de trabajo

Lee ROADMAP.md, docs/data.md y docs/high-risk.md junto con las incidencias citadas y el estado de las versiones y las etiquetas. Actualiza la hoja de ruta y las indicaciones sobre versiones para que reflejen lo que ya se ha publicado, y revisa la guía High-risk para los lectores que usan enlaces a páginas de entrada. La tarea estará terminada cuando las páginas reflejen el estado actual del proyecto y la guía no contenga jerga de flujos de trabajo ni rutas del repositorio.

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

Descripción

documentation priority: medium

Why it matters

These pages are what visitors read to judge whether the project is current and trustworthy. Each one below states something that is no longer true, or speaks to the maintainer rather than the reader.

Evidence

  • ROADMAP.md:26 lists "the guides rendered as site pages, and an engine filter" under planned work. Both shipped (#159, #160).
  • ROADMAP.md:37 lists "Monthly dataset releases tagged vYYYY.MM.DD" as done, but git tag and gh release list are both empty (#137 is still open).
  • docs/data.md:17 points readers to releases that do not exist yet.
  • docs/high-risk.md, now rendered at /guide/high-risk/, opens with "Do not catalog / high risk" and maintainer instructions ("Do not catalog until…"). It cites repo paths such as catalog/shaders-vfx/godot-shaders.md instead of entry pages. #146 cleaned the other guides but missed this one.

Suggested approach

  • Move the shipped items to Done, and move releases back to Planned until #137 lands.
  • Make data.md say "releases: coming", or link the raw exports instead.
  • Retitle high-risk.md for readers (e.g. "Free sources that aren't safe to ship"), rewrite its imperatives as reader advice, and link entry pages.
  • Consider a validator rule that rejects backticked catalog/... paths in public guides.

Done when

ROADMAP and data.md match the tags and closed issues, and the High-risk guide contains no workflow jargon or repo paths.

Lenguaje dominante
JavaScript
Estrellas
58
Forks
15
Merge medio
1 d 7 h
PR fusionados (30 d)
12

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.