Give needs-review entries a structured open question and surface it

Aberta
  • Algo errado?
#211 1 comentário 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
35/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
javascript, node.js
Domínio
tooling

Direção de pesquisa

Start with the V9 - Deprecated: rule in site/checks.mjs and the age-only sorting in site/lib/reverify.mjs (lines 23-31), then see where needs-review is documented in CONTRIBUTING.md. Done means every needs-review entry carries a - Review: line that the checks enforce, the question appears on the entry page and in data.json, and the monthly re-verify issue lists them. The open decision on grandfathering existing entries needs a maintainer answer before implementing. Run npm run check to verify.

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

Descrição

enhancement priority: medium

Summary

43 entries are needs-review, none with a machine-readable statement of what is unresolved. deprecated requires a - Deprecated: line (V9); needs-review has no equivalent. The re-verify batch sorts by age only, so a recently checked needs-review entry waits months and contributors never see its question.

Related: #99

Where

  • CONTRIBUTING.md:16
  • site/lib/reverify.mjs:23-31
  • site/checks.mjs (V9 - Deprecated: rule)

Suggested fix

  • Add a - Review: marker line, enforced the way V9 is.
  • Show it on the entry page and in data.json.
  • Append an "Open questions" section to the monthly re-verify issue.

Open question: grandfather existing entries for one cycle while backfilling?

Acceptance criteria

  • Every needs-review entry states its open question
  • The re-verify issue lists them

Getting started

  • Relevant files: site/checks.mjs, site/lib/reverify.mjs, site/lib/entry-page.mjs
  • How to run tests: npm test (unit tests), npm run check (tests + validate + build). Node 22+, no dependencies.
  • Related docs: site/README.md, CONTRIBUTING.md

Filed by repo-audit/full-audit at 982fcd9. Severity: medium. Effort: M. audit-key: enhancement|site/checks.mjs|needs-review-marker

Linguagem predominante
JavaScript
Estrelas
58
Forks
15
Merge médio
1d 14h
PRs com merge (30d)
11

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/Free-Game-Dev-Assets

Todas as issues de TMHSDigital/Free-Game-Dev-Assets

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.