claimed-framework/mlx

Address caveats katalog update script

Offen

#222 geöffnet am 23.09.2021

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (1 zugewiesene Person)Python (54 Forks)github user discovery
help wanted

Repository-Metriken

Stars
 (218 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Verstehe das aktuelle Katalog Update Skript in /hack und implementiere dann die aufgeführten Verbesserungen Schritt für Schritt: Verschieben nach /tools/python, Dokumentation hinzufügen, Ändern, um das Repo in ein temporäres Verzeichnis zu klonen, sicherstellen, dass der Benutzer über alle Änderungen informiert wird, und vorhandene Assets aus catalog upload.json erhalten.
Tech Stack
python
Domain
backend
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitPython
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75