Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Docs describe removed code: rules/catalog.py, main.py/baseline-mcp, check adapters, darnit.plugins entry-point group

オープン
#488 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
48/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
python
領域
documentation

調査の方向性

Start by comparing the cited documentation with the current package layout and the evidence at SHA 032493b; the issue names CLAUDE.md, the constitution, framework-design.md, and several guides. Check the constitution’s amendment process and coordinate with the dead-code cleanup issue, as suggested. Done means stale paths, commands, plugin mechanisms, and TOML locations are corrected or clearly marked historical, with any CI guard scoped to removed paths.

索引モデルが issue の本文から書いたものです。

説明

documentation good first issue quality

Summary

Contributor-facing and governance docs on main still describe modules, entry points, and file layouts that no longer exist. Some of these docs are cited as authoritative (CLAUDE.md, the constitution, framework-design.md), so new contributors and coding agents follow them.

Impact

Plugin authors copy dead patterns (adapters, get_rules_catalog, TOML outside src/). Two of the examples contradict the feature 021 rule on framework TOML location. The SARIF/catalog sync rule in CLAUDE.md enforces against a file that was deleted in 7985340.

Evidence (SHA 032493b)

rules/catalog.py (removed in 7985340; darnit_baseline/rules/ no longer exists):

  • CLAUDE.md:27 (package tree lists rules/), :239, :250-252
  • .specify/memory/constitution.md:154, :256
  • docs/architecture/framework-design.md:1020
  • ARCHITECTURE.md:116, :519
  • docs/MIGRATION_GUIDE.md:115
  • docs/SARIF_DESIGN.md:16, 286-300, 372, 447 (main.py, baseline_mcp/, rules_catalog.py)

Pre-rename main.py / baseline-mcp layout:

  • docs/USAGE_GUIDE.md:23, 46-47, 62, 73, 396 (clone yourorg/baseline-mcp, python main.py)
  • docs/DECISION_FLOWS.md:1555-1591 (functions "in main.py", project.toml, ToolRegistry.get_check_adapter, BuiltinCheckAdapter), plus diagrams at :800-890, :1468-1470
  • User-facing strings: attestation/signing.py:90 and attestation/__init__.py:40 say pip install baseline-mcp[attestation] (the extra lives on darnit-core)

Adapter system / unused protocol methods (see the dead-code cleanup issue):

  • CLAUDE.md:73-76, ARCHITECTURE.md:383-384, docs/IMPLEMENTATION_GUIDE.md:287-309, 360-363, 1772, docs/tutorials/create-new-implementation.md:214
  • docs/plugin-discovery-design.md:19, 94-106, docs/SECURITY_GUIDE.md:161 (CheckAdapter subclassing)

Nonexistent plugin mechanisms:

TOML location contradicting feature 021 (CLAUDE.md:145):

  • CLAUDE.md:121 (Path(__file__).parent), core/plugin.py:110 docstring, docs/IMPLEMENTATION_GUIDE.md:369, docs/tutorials/create-new-implementation.md:222 (Path(__file__).parent.parent.parent)

Reproduction

ls packages/darnit-baseline/src/darnit_baseline/rules (no such directory); grep -rn "darnit.plugins\"" packages (no match); git grep -n "main.py" docs/USAGE_GUIDE.md.

Suggested direction

Delete or archive USAGE_GUIDE.md, DECISION_FLOWS.md, SARIF_DESIGN.md (or mark historical); fix the CLAUDE.md / constitution / framework-design references in one PR (constitution change follows its own amendment process); land after the dead-code cleanup so docs and code change together. Consider a CI grep guard for removed paths.

主要言語
Python
スター
22
フォーク
27
平均マージ
2日 28分
マージ済み PR(30日)
40

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

darnitdevorg/darnit のほかの issue

darnitdevorg/darnit の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。