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

Aperta Adatta ai principianti
  • Qualcosa non va?
#46 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
82/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
javascript, markdown
Ambito
documentation

Direzione di ricerca

Inizia dai documenti di rilascio elencati: docs/RELEASE.md, releases/RELEASE_NOTES_v0.1.0.md e releases/RELEASE_GUIDE_v0.1.0.md; controlla anche i nomi delle etichette del repository e la versione in package.json. Correggi l’elenco delle etichette, i percorsi delle note, i link al changelog e le indicazioni sulla versione nelle istruzioni di rilascio e nel modello. Il lavoro è terminato quando ogni discrepanza elencata è stata risolta.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
JavaScript
Stelle
4
Fork
2
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di TMHSDigital/Static_Chess

Tutte le issue di TMHSDigital/Static_Chess

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.