canonical/cloud-init

[enhancement]: Relocate json schemas somewhere more sensible

Ouverte

#4 688 ouverte le 13 déc. 2023

Voir sur GitHubGuide contributeur
 (6 commentaires) (2 réactions) (0 personne assignée)Python (1 108 forks)auto 404
enhancementgood first issue

Métriques du dépôt

Stars
 (3 772 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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)

Guide contributeur

Direction de recherche
Créez un nouveau répertoire (par exemple schema/) à la racine du dépôt. Déplacez tous les fichiers de schéma JSON de cloudinit/config/schemas/ vers ce répertoire. Mettez à jour toutes les références dans cloudinit/schema.py, les fichiers de test et setup.py (par exemple package data ou data files) pour pointer vers le nouvel emplacement. Assurez vous que les tests passent. Considérez les implications pour l'empaquetage des distributions via des ajustements dans setup.py.
Stack technique
python
Domaine
backenddevops
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60