README and docs advertise features that the published 0.1.2 does not have
メンテナーはふだん 2 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 38/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- node.js, typescript
- 領域
- documentation, release
調査の方向性
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.
索引モデルが issue の本文から書いたものです。
説明
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
- 主要言語
- TypeScript
- スター
- 0
- フォーク
- 6
- 平均マージ
- 1日 21時間
- マージ済み PR(30日)
- 8
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
TMHSDigital/godot-correctness-mcp のほかの issue
-
enhancement good first issue severity: medium
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
TMHSDigital/godot-correctness-mcp#123 ·
メンテナーはふだん 2 日以内に返信
-
dependencies good first issue severity: low
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
TMHSDigital/godot-correctness-mcp#116 ·
メンテナーはふだん 2 日以内に返信
-
bug good first issue severity: low
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
TMHSDigital/godot-correctness-mcp#107 ·
メンテナーはふだん 2 日以内に返信
-
bug good first issue severity: low
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
TMHSDigital/godot-correctness-mcp#106 ·
メンテナーはふだん 2 日以内に返信
-
bug good first issue severity: medium
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
TMHSDigital/godot-correctness-mcp#105 ·
メンテナーはふだん 2 日以内に返信
TMHSDigital/godot-correctness-mcp の issue をすべて見る
似ている issue
-
clawsweeper:needs-maintainer-review clawsweeper:needs-product-decision clawsweeper:no-new-fix-pr clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster P3
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
openclaw/openclaw#203385 · コメント 1 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
nwverse/persona#12800 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 80/100
メンテナーはふだん 1 日以内に返信
-
[MCP]: page snapshots in .playwright-mcp/ are not git-ignored (.playwright-cli/ is, since #42318)オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
microsoft/playwright#44289 ·
メンテナーはふだん 1 日以内に返信
-
good first issue
難易度 2/5 半日 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信