canonical/cloud-init

[enhancement]: Relocate json schemas somewhere more sensible

Offen

#4.688 geöffnet am 13.12.2023

Auf GitHub ansehenContributor Guide
 (6 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)Python (1.108 Forks)auto 404
enhancementgood first issue

Repository-Metriken

Stars
 (3.772 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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)

Contributor Guide

Research-Richtung
Erstellen Sie ein neues Verzeichnis (z.B. schema/) im Repository Stamm. Verschieben Sie alle JSON Schemadateien von cloudinit/config/schemas/ in dieses Verzeichnis. Aktualisieren Sie alle Verweise in cloudinit/schema.py, Testdateien und setup.py (z.B. package data oder data files), um auf den neuen Speicherort zu verweisen. Stellen Sie sicher, dass die Tests bestehen. Berücksichtigen Sie die Auswirkungen auf das Distributions Packaging durch Anpassungen in setup.py.
Tech Stack
python
Domain
backenddevops
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60