canonical/cloud-init

[enhancement]: Relocate json schemas somewhere more sensible

Aberta

#4.688 aberto em 13 de dez. de 2023

Ver no GitHubGuia do colaborador
 (6 comentários) (2 reações) (0 responsável)Python (1.108 forks)auto 404
enhancementgood first issue

Métricas do repositório

Stars
 (3.772 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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)

Guia do colaborador

Direção de pesquisa
Crie um novo diretório (ex: schema/) na raiz do repositório. Mova todos os arquivos de esquema JSON de cloudinit/config/schemas/ para esse diretório. Atualize todas as referências em cloudinit/schema.py, arquivos de teste e setup.py (ex: package data ou data files) para apontar para o novo local. Certifique se de que os testes passem. Considere as implicações de empacotamento da distribuição por meio de ajustes no setup.py.
Pilha de tecnologia
python
Domain
backenddevops
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Python
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60