canonical/cloud-init

[enhancement]: Relocate json schemas somewhere more sensible

Aperta

#4688 aperta il 13 dic 2023

Vedi su GitHubGuida contributor
 (6 commenti) (2 reazioni) (0 assegnatari)Python (1108 fork)auto 404
enhancementgood first issue

Metriche repository

Star
 (3772 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Enhancement

All of our jsonschemas are hidden down under cloudinit/config/schemas/, which doesn't make sense:

a) these files contain data not Python code b) some of these files are not specific to configuration modules c) the __init__.py was never required

These file should exist in a directory under the top directory, probably named something like schema (alternatively jsonschema or maybe something more generic like data).

Expected changes:

  • code in cloudinit/, specifically schema.py
  • test/unittest/
  • setup.py
  • possibly distro packaging too (presumably avoidable with setup.py finesse)

Guida contributor

Direzione di ricerca
Crea una nuova directory (es. schema/) nella radice del repository. Sposta tutti i file di schema JSON da cloudinit/config/schemas/ in quella directory. Aggiorna tutti i riferimenti in cloudinit/schema.py, nei file di test e in setup.py (es. package data o data files) per puntare alla nuova posizione. Assicurati che i test passino. Considera le implicazioni per il packaging della distribuzione tramite modifiche a setup.py.
Tech stack
python
Dominio
backenddevops
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60