Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta
  • Qualcosa non va?
#488 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Python
Stelle
22
Fork
27
Merge medio
2g 28m
PR unite (30g)
40

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di darnitdevorg/darnit

Tutte le issue di darnitdevorg/darnit

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.