README, docs and tool descriptions are stale for the 0.2 surface
Maintainer antworten meist innerhalb von 2 Tagen
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 76/100
- Issue-Typ
- Dokumentation
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- node.js, typescript
- Bereich
- devtools, documentation
Rechercherichtung
Start with README.md, docs/lint.md, docs/scenes.md, docs/index.html, skills/signal-hygiene.md, src/tools/lint.ts, and BACKLOG.md; compare the listed descriptions with the source locations cited in the issue. Update the documented behavior and move signal-callback-arity to Next. Run npm run generate:tools after changing the tool description; done when the listed inconsistencies are corrected and the generated tool metadata is current.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Summary
After the 0.2.0 feature work, several docs and tool descriptions are out of date. Grouped by document.
README.md
- README:63-65 says "The lint, validate, and report tools take an optional
baselinefile".lint_filehas nobaselineargument (src/tools/lint.ts:27-33), and an MCP client sending one gets it silently stripped. Say "lint_project, the validate_* tools, and project_report". - README:74-76 lists five commands and leaves out
gdcorrect rules [projectPath].rulesalso rejects--format sarifwith exit 2 (src/cli.ts:262-265), while the options table implies every format works for every command. - Relative baseline paths resolve against the cwd in the CLI and against the project root in MCP (
src/baseline.ts:105-108,src/baseline.ts:133-138). This is not documented. It is tracked as a code issue too; document whichever rule is settled on. - Node.js 22 or newer is required (
engines.node >=22.0.0), but neither the Installation section nor docs/index.html says so.
docs/lint.md and docs/index.html
- docs/lint.md:24-25, docs/lint.md:168 and the CI section of docs/index.html describe exit 1 as error-severity findings only, and exit 2 as tool failure. In fact exit 1 means "findings at or above
--fail-on(defaulterror)", and exit 2 also covers usage and config errors (src/cli.ts:93-107). README and--helpare already correct. - docs/lint.md:78-81 and the comment at
src/lint/project.ts:8say thegodotVersionpayload field is "the default removed-api-usage target". It is actually the raw declared version fromproject.godot. The target ispinnedVersionFor(declared), so a 4.6 project reports"4.6"but is checked against 4.5. Reword, or also emit the effective target.
docs/scenes.md
- docs/scenes.md:9-12 says
validate-registriesreturns{ root, findings, count }plusentries. It actually returns{ root, findings, entries }with nocount(src/cli.ts:57,src/tools/scenes.ts:83). - docs/scenes.md:64-66: a registry value is only checked if it also contains
/, ends in a resource extension, or starts withres://(src/scenes/paths.ts:50-52). Soicon_texture = "icon.png"is never checked, anduid://strings in registries are never resolved (paths.ts:29). Document both limits.
Rule and tool descriptions
-
skills/signal-hygiene.md:33-34and theconnect-without-disconnectrule description (src/lint/rules/connect-without-disconnect.ts:11, shown bylist_rules) say "no matching disconnect". The rule actually checks for anydisconnect()anywhere in the file (lines 14-19), as docs/lint.md:20 correctly says. - The
lint_filetool description says "against the default ruleset" (src/tools/lint.ts:22-26), but the tool loads the project config. Regeneratemcp-tools.jsonafter the fix.
BACKLOG.md
- BACKLOG.md:6 and :32 list
signal-callback-arityunder "## v0.2" with "Not implemented in v0.1.0". 0.2.0 ships without it; move it to "Next".
Getting started
- Relevant files: README.md, docs/lint.md, docs/scenes.md, docs/index.html, skills/signal-hygiene.md, src/tools/lint.ts, BACKLOG.md
- Run
npm run generate:toolsafter changing a tool description.
Filed by repo-audit/full-audit at e836036. Severity: low. Effort: S. audit-key: documentation|README.md|0.2-surface
- Vorherrschende Sprache
- TypeScript
- Sterne
- 0
- Forks
- 6
- Ø Merge
- 1 T. 21 Std.
- Gemergte PRs (30 T.)
- 8
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus TMHSDigital/godot-correctness-mcp
-
enhancement good first issue severity: medium
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
TMHSDigital/godot-correctness-mcp#123 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
dependencies good first issue severity: low
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
TMHSDigital/godot-correctness-mcp#116 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
bug good first issue severity: low
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
TMHSDigital/godot-correctness-mcp#107 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
bug good first issue severity: low
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
TMHSDigital/godot-correctness-mcp#106 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
bug good first issue severity: medium
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 84/100
TMHSDigital/godot-correctness-mcp#105 ·
Maintainer antworten meist innerhalb von 2 Tagen
Alle Issues in TMHSDigital/godot-correctness-mcp
Ähnliche Issues
-
clawsweeper:needs-maintainer-review clawsweeper:needs-product-decision clawsweeper:no-new-fix-pr clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster P3
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
openclaw/openclaw#203385 · 1 Kommentar · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
nwverse/persona#12800 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 80/100
Maintainer antworten meist innerhalb von 1 Tag
-
[MCP]: page snapshots in .playwright-mcp/ are not git-ignored (.playwright-cli/ is, since #42318)Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
microsoft/playwright#44289 ·
Maintainer antworten meist innerhalb von 1 Tag
-
good first issue
Schwierigkeit 2/5 Ein halber Tag Anfängerfreundlichkeit 65/100
Maintainer antworten meist innerhalb von 1 Tag