claimed-framework/mlx

Address caveats katalog update script

Aberta

#222 aberto em 23 de set. de 2021

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (1 responsável)Python (54 forks)github user discovery
help wanted

Métricas do repositório

Stars
 (218 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

We need to address (some of) the current caveats in the catalog update script:

  • move script from /hack to /tools/python
  • add developer documentation
  • clone the katalog repo into a temp directory instead of relying on the user to have done it prior to running the script
  • not all of the YAML files in the katalog repo may want to be included in the catalog upload, so alert the user to all the changes instead of relying on git diff
  • read the catalog_upload.json file prior to regenerating it to capture assets that live outside the katalog repo and re-add them later

Originally posted by @ckadner in https://github.com/machine-learning-exchange/mlx/issues/200#issuecomment-926195710

Guia do colaborador

Direção de pesquisa
Entenda o script de atualização do catálogo atual em /hack, depois implemente as melhorias listadas passo a passo: mova para /tools/python, adicione documentação, modifique para clonar o repositório em um diretório temporário, garanta que o usuário seja alertado sobre todas as alterações e preserve os ativos existentes do catalog upload.json.
Pilha de tecnologia
python
Domain
backend
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.
1-3 horas
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
GitPython
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75