claimed-framework/mlx

Address caveats katalog update script

Aperta

#222 aperta il 23 set 2021

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (1 assegnatario)Python (54 fork)github user discovery
help wanted

Metriche repository

Star
 (218 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Comprendi lo script di aggiornamento del catalogo corrente in /hack, quindi implementa i miglioramenti elencati passo dopo passo: sposta in /tools/python, aggiungi documentazione, modifica per clonare il repo in una directory temporanea, assicurati che l'utente sia avvisato di tutte le modifiche e preserva gli asset esistenti da catalog upload.json.
Tech stack
python
Dominio
backend
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
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
GitPython
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75