DOI-USGS / DOI-USGS/dataretrieval-python

Amend configuration ADRs for the two-module subsystem

Aperta
#410 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

ready-for-agent
Lingua principale
Python
Stelle
266
Fork
63
Merge medio
1g 20h
PR unite (30g)
19

Descrizione

## What to build

Bring the accepted configuration records back into agreement with the architecture that the code and fitness functions currently enforce: a small public configuration interface over a private configuration foundation, with both modules constrained to dependency-free package leaves and the standard library.

Treat this as an additive, behavior-neutral amendment under ADR 0000, not a new or superseding decision. The layered-configuration record should own the complete dependency rule; later profile records and adjacent contributor prose should cite it rather than restating a stale single-module model.

## Acceptance criteria

- [ ] No current configuration ADR claims that configuration is a single module or that exceptions are its only first-party dependency.
- [ ] The owning record states the permitted dependencies for both the public interface and private foundation exactly as the fitness function enforces them.
- [ ] The owning record's status and notes identify the additive amendment and explain that public imports and behavior did not change.
- [ ] Later configuration records cite the owning dependency rule instead of duplicating it.
- [ ] Adjacent contributor and architecture prose contains no stale single-module description.
- [ ] No production code, public import path, configuration behavior, or fitness-function policy changes.
- [ ] ADR-reference checks, architecture tests, dependency contracts, and the documentation build pass.

## Blocked by

None — can start immediately.

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Individua ADR 0000, il documento sulla configurazione a livelli, i successivi documenti sui profili e i testi adiacenti relativi ai contributi e all’architettura. Leggi le regole attuali sulle dipendenze ed esegui i controlli dei riferimenti agli ADR, i test di architettura, i contratti delle dipendenze e la build della documentazione. Il lavoro è completato quando i documenti descrivono coerentemente entrambi i moduli e tutti i controlli elencati vengono superati senza modifiche alla produzione o alle policy.

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

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Attiva
Chiarezza
Abbastanza chiara
Idoneità per principianti
68/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.