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

Rewrite CLAUDE.md against the real architecture; resolve the 3-way mocking-policy contradiction

Aperta
  • Qualcosa non va?
#125 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation, tooling

Direzione di ricerca

Inizia confrontando CLAUDE.md, .claude/CLAUDE.md, README.md, pyproject.toml e setup.py, quindi esamina la struttura dei moduli e i file dell’executor indicati nell’issue. Traccia i punti di estensione effettivi attraverso executor_core.py, executor_schedulers.py ed executor_kubernetes.py prima di armonizzare la documentazione relativa all’architettura, alla versione, al mocking e allo stato obsoleto. Il lavoro è completato quando la checklist di accettazione è soddisfatta, incluso un controllo CI per individuare simboli o percorsi inesistenti di CLAUDE.md.

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

Descrizione

documentation P2-medium

Part of #108 · Phase 5 · label: documentation

Problem

CLAUDE.md is the file every AI coding session loads as ground truth, so its inaccuracies propagate into work. Verified inaccuracies:

  • "Add new cluster type to ClusterType enum in config.py" — no such symbol exists. grep -rn ClusterType clustrix/ returns nothing; config.py:19 uses a plain cluster_type: str. Anyone following this instruction is looking for a thing that isn't there.
  • "ClusterExecutor (clustrix/executor.py): Central execution engine handling job submission, SSH connection management, file transfer, job monitoring..." — executor.py is a 39-line re-export shim (:1-38). The real logic lives in executor_core.py (466), executor_connections.py (389), executor_schedulers.py (378), executor_scheduler_status.py (651), executor_kubernetes.py (461), executor_cloud.py (470) — none of which CLAUDE.md mentions.
  • "Implement _submit_{type}_job method in ClusterExecutor" — these are back-compat wrappers (executor_core.py:430-448); real work is in SchedulerManager.submit_*_job / KubernetesJobManager.
  • The architecture section omits most of the package: the entire notebook stack (notebook_magic_{core,config,widget,mocks,enhanced,aws,azure,gcp,ssh}.py, modern_notebook_widget.py at 1,631 lines), plus cloud_providers/, cost_providers/, pricing_clients/, kubernetes/, credential_manager.py, auth_manager.py, function_flattening.py, gpu_utils.py.
  • "The project is in beta (v0.1.0)" — pyproject.toml and setup.py say 0.1.1.
  • Direct self-contradiction on mocking. CLAUDE.md says unit tests "Mock external dependencies"; .claude/CLAUDE.md says "Do not use mock services for anything ever"; README.md claims "Zero use of @patch, Mock()". Three files, three incompatible policies — which is a large part of how the suite ended up with 2,513 mock occurrences while claiming to have none.

Verified accurate, for the record (do not "fix" these): scripts/check_quality.py, scripts/pre_push_check.py, scripts/run_real_world_tests.py with its documented flags, both installed git hooks, and the entire filesystem-utilities section.

Stale project-management state

Path Verdict
notes/ One file, github_sub_issues_mapping_2025-09-04.md, ~11.5 months old, covers only #101/#103
.claude/epics/remove-1password/ Orphaned — has 97.md + 97-analysis.md but no epic.md, no status
.claude/epics/test-coverage-90-percent/ status: backlog for an epic with 30 unpushed commits claiming completion
Untracked WIP coverage_detailed_report.txt, 103-*.md, updates/103/

Acceptance criteria

  • CLAUDE.md architecture section regenerated from the actual module layout
  • The ClusterType enum instruction removed or the enum introduced
  • "Adding a new cluster type" rewritten against the real extension points (SchedulerManager, the provider ABC from the Phase 3 issue)
  • One mocking policy, stated once, consistent across CLAUDE.md, .claude/CLAUDE.md, and README.md
  • Version reference removed from prose, or sourced from a single location
  • notes/ and .claude/epics/ reconciled with reality or archived
  • A CI check that fails when CLAUDE.md references a symbol or path that does not exist — the same drift will otherwise recur
Lingua principale
Python
Stelle
10
Fork
4
Nessuna PR unita negli ultimi 30g

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 ContextLab/clustrix

Tutte le issue di ContextLab/clustrix

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.