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

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#46 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
82/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
javascript, markdown
Domaine
documentation

Piste de recherche

Commencez par les documents de publication indiqués : docs/RELEASE.md, releases/RELEASE_NOTES_v0.1.0.md et releases/RELEASE_GUIDE_v0.1.0.md ; vérifiez également les noms des étiquettes du dépôt et la version de package.json. Corrigez la liste des étiquettes, les chemins des notes, les liens vers le journal des modifications et les indications de version dans les instructions de publication et le modèle. Le travail est terminé lorsque chaque divergence indiquée a été corrigée.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
JavaScript
Étoiles
4
Forks
2
Aucune PR mergée en 30 j

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de TMHSDigital/Static_Chess

Toutes les issues de TMHSDigital/Static_Chess

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.