Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
  • Có gì không ổn?
#488 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
48/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Python
Star
22
Fork
27
Merge trung bình
1 ngày 20 giờ
Pull request đã merge (30 ngày)
39

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của darnitdevorg/darnit

Tất cả issue của darnitdevorg/darnit

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.