claimed-framework/mlx

Address caveats katalog update script

Ouverte

#222 ouverte le 23 sept. 2021

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (1 personne assignée)Python (54 forks)github user discovery
help wanted

Métriques du dépôt

Stars
 (218 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Guide contributeur

Direction de recherche
Comprenez le script de mise à jour du catalogue actuel dans /hack, puis implémentez les améliorations listées étape par étape : déplacer vers /tools/python, ajouter de la documentation, modifier pour cloner le dépôt dans un répertoire temporaire, s'assurer que l'utilisateur est alerté de toutes les modifications et conserver les actifs existants de catalog upload.json.
Stack technique
python
Domaine
backend
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.
1-3 heures
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
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75