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

Aberta Para iniciantes
  • Algo errado?
#46 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
82/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
javascript, markdown
Domínio
documentation

Direção de pesquisa

Comece pelos documentos de lançamento listados: docs/RELEASE.md, releases/RELEASE_NOTES_v0.1.0.md e releases/RELEASE_GUIDE_v0.1.0.md; confira também os nomes dos labels do repositório e a versão em package.json. Corrija a lista de labels, os caminhos das notas, os links para o changelog e as orientações sobre a versão nas instruções de lançamento e no modelo. A tarefa estará concluída quando cada discrepância listada tiver sido corrigida.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
JavaScript
Estrelas
4
Forks
2
Nenhum PR com merge em 30d

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de TMHSDigital/Static_Chess

Todas as issues de TMHSDigital/Static_Chess

Issues semelhantes

Mais issues de JavaScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.