Release docs: missing labels, broken changelog link, inconsistent notes path

Abierto Apto para principiantes
  • ¿Algo no está bien?
#46 0 comentarios 0 reacciones 0 asignados Ver en GitHub

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
javascript, markdown
Área
documentation

Línea de trabajo

Empieza por los documentos de publicación indicados: docs/RELEASE.md, releases/RELEASE_NOTES_v0.1.0.md y releases/RELEASE_GUIDE_v0.1.0.md; comprueba también los nombres de las etiquetas del repositorio y la versión de package.json. Corrige la lista de etiquetas, las rutas de las notas, los enlaces al registro de cambios y las indicaciones sobre la versión en las instrucciones de publicación y la plantilla. El trabajo estará terminado cuando se haya corregido cada discrepancia indicada.

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

Descripción

documentation good first issue severity: low

Summary

Several statements in the release documentation do not match the repository.

Where

  • docs/RELEASE.md:10, :16-19, :67, :72
  • releases/RELEASE_NOTES_v0.1.0.md:60, releases/RELEASE_GUIDE_v0.1.0.md:6

Details

  • Labels (:72). The triage line names a11y and perf; neither label exists in the repository.
  • Notes path (:10, :18). Both say to create RELEASE_NOTES_vX.Y.Z.md with no directory; only :46 says releases/. The workflow looks in releases/ first. releases/RELEASE_GUIDE_v0.1.0.md:6 has the same omission.
  • Broken link. releases/RELEASE_NOTES_v0.1.0.md:60 links [CHANGELOG.md](CHANGELOG.md), which does not resolve from releases/ or from the published release page.
  • Version. package.json is 0.0.0 although v0.1.0 is released, and the release steps never mention the version field.

Suggested fix

Create the two labels or drop them from the list. Write releases/RELEASE_NOTES_vX.Y.Z.md everywhere. Use an absolute URL for the changelog link in the notes and in the template. Add a "bump the package version" step or state that the field is unused.

Acceptance criteria

  • Each item above is corrected

Getting started

  • Relevant files: docs/RELEASE.md, releases/RELEASE_NOTES_v0.1.0.md, releases/RELEASE_GUIDE_v0.1.0.md
  • How to run tests: npm install, then npm test and npm run lint
  • Related docs: docs/ARCHITECTURE.md, .github/CONTRIBUTING.md

Filed by repo-audit/full-audit at 8a2c86c. Severity: low. Effort: S. audit-key: documentation|docs/RELEASE.md|release-process

Lenguaje dominante
JavaScript
Estrellas
4
Forks
2
Sin PR fusionados en 30 d

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/Static_Chess

Todos los issues de TMHSDigital/Static_Chess

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.