README and docs advertise features that the published 0.1.2 does not have
Los mantenedores suelen responder en 2 días
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 38/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- node.js, typescript
- Área
- documentation, release
Línea de trabajo
Read the listed README.md and docs snippets alongside CHANGELOG.md, ROADMAP.md, and package.json; compare their claims and version ranges with the published 0.1.2 behavior described in the issue. Check the release workflow and relevant tags to confirm what is shipped. Done means the docs and CI snippets match available releases, and the changelog and roadmap accurately reflect shipped features.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Summary
SARIF output, baselines, inline suppressions, removed-api-usage, uid resolution, the deeper scene checks and the input-action check have all landed on main since v0.1.2, which is still npm latest. These features sit under [Unreleased] in the CHANGELOG. The README and docs snippets run npx -y -p @tmhs/godot-correctness-mcp gdcorrect ... without a version, so users get 0.1.2, and the copy-paste CI recipes either fail or silently do nothing.
Where
README.md:71-120(CLI and CI section)docs/lint.md:65-116(removed-api-usage, suppressions, CI)docs/scenes.md(scene, uid and input-action rule tables)CHANGELOG.md:7-23,CHANGELOG.md:51ROADMAP.md:22-31
Details
In 0.1.2, parseArgs only knows --format/-f, and the format check rejects anything except json or pretty. That gives these results:
- The README SARIF workflow exits 2 with
Unknown format: sarif.continue-on-errorhides the failure, andupload-sarifthen fails on a missing file. -
--write-baseline/--baselineare treated as positional arguments and ignored. No baseline is written, so the CI gate fails on every existing finding. - Inline suppressions and
removed-api-usageare silently ignored. - The scene/uid/input-action checks listed in docs/scenes.md are never reported.
Related staleness:
-
CHANGELOG.mdlists "AddedTHIRD_PARTY_NOTICES.md" under 0.1.1, but the file is not in thev0.1.1orv0.1.2tags; it was added after 0.1.2. The same line also appears under Unreleased. - Most unchecked items in
ROADMAP.mdv0.2.0/v1.0.0 are already implemented: suppressions, SARIF, baseline, uid, scene checks, input actions, removed-API rule and node-path validation. Onlysignal-callback-arityand the stable JSON contract remain.
Suggested fix
Cut the release: npm version minor --no-git-tag-version, move [Unreleased] to [0.2.0], and push so release.yml tags and publishes it. Pin the snippets to @tmhs/godot-correctness-mcp@^0.2. Also fix the CHANGELOG 0.1.1 line and tick the ROADMAP items.
Acceptance criteria
- npm
latestcontains every feature documented in README/docs, or the docs mark each one with its minimum version - The CI snippets pin a version range
- The CHANGELOG and ROADMAP match what is actually shipped
Related: #26
Related: #33
Related: #34
Related: #53
Getting started
- Relevant files:
README.md,docs/lint.md,docs/scenes.md,CHANGELOG.md,ROADMAP.md,package.json - How to run tests:
npm run build && npm test(andnpm run typecheck) - Related docs:
CONTRIBUTING.md,AGENTS.md
Filed by repo-audit/full-audit at 5d49f5d. Severity: high. Effort: S. audit-key: documentation|README.md|CLI and CI
- Lenguaje dominante
- TypeScript
- Estrellas
- 0
- Forks
- 6
- Merge medio
- 1 d 21 h
- PR fusionados (30 d)
- 8
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de TMHSDigital/godot-correctness-mcp
-
enhancement good first issue severity: medium
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
TMHSDigital/godot-correctness-mcp#123 ·
Los mantenedores suelen responder en 2 días
-
dependencies good first issue severity: low
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
TMHSDigital/godot-correctness-mcp#116 ·
Los mantenedores suelen responder en 2 días
-
bug good first issue severity: low
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
TMHSDigital/godot-correctness-mcp#107 ·
Los mantenedores suelen responder en 2 días
-
bug good first issue severity: low
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
TMHSDigital/godot-correctness-mcp#106 ·
Los mantenedores suelen responder en 2 días
-
bug good first issue severity: medium
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
TMHSDigital/godot-correctness-mcp#105 ·
Los mantenedores suelen responder en 2 días
Todos los issues de TMHSDigital/godot-correctness-mcp
Issues similares
-
clawsweeper:needs-maintainer-review clawsweeper:needs-product-decision clawsweeper:no-new-fix-pr clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster P3
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
openclaw/openclaw#203385 · 1 comentario · 1 reacción ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
nwverse/persona#12800 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 80/100
Los mantenedores suelen responder en 1 día
-
[MCP]: page snapshots in .playwright-mcp/ are not git-ignored (.playwright-cli/ is, since #42318)Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
microsoft/playwright#44289 ·
Los mantenedores suelen responder en 1 día
-
good first issue
Dificultad 2/5 Medio día Aptitud para principiantes 65/100
Los mantenedores suelen responder en 1 día