claimed-framework/mlx

Address caveats katalog update script

Open

#222 opened on Sep 23, 2021

View on GitHubContributor guide
 (1 comment) (0 reactions) (1 assignee)Python (54 forks)github user discovery
help wanted

Repository metrics

Stars
 (218 stars)
PR merge metrics
 (No merged PRs in 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

Contributor guide

Research direction
Understand the current catalog update script in /hack, then implement the listed improvements step by step: move to /tools/python, add documentation, modify to clone repo into temp, ensure user is alerted to all changes, and preserve existing assets from catalog upload.json.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75