Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (29 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

38 lines (29 loc) · 1.59 KB
Raw

Contributing

Submitting a package

See SCHEMA.md for the full manifest spec and steps. Short version:

  1. Add an mpy-registry.yaml manifest to the root of your own package repo (copy examples/mpy-registry.yaml as a starting point). GitHub repos only for now.
  2. Open a PR against this repo adding your repo's URL as one new line to packages.txt, alphabetically sorted. Don't touch any other files in this PR.
  3. CI validates your manifest and merges automatically on success - see SCHEMA.md's trust note for what that does and doesn't mean.

If CI fails, the job log tells you exactly which check failed and why (unreachable repo, missing manifest, schema mismatch, or name collision). Fix your own repo/manifest and push again to the same PR branch - no need to open a new one.

Changing anything else in this repo

Schema/docs/CI changes are regular PRs, reviewed like any other project - the auto-merge behavior above only applies to packages.txt changes.

Project status

Early build-out, not yet launched. Current progress against the project plan:

  • Phase 1 - manifest schema (schema.json, SCHEMA.md)
  • Phase 2 - CI validation + auto-merge
  • Phase 3 - index generation (dist/index.json, dist/categories/*.json)
  • Phase 4 - discovery website
  • Phase 5 - launch / seed content
  • Phase 6 - custom mip index (optional, later) - worker/, verified against real hardware; not yet deployed to a public URL (needs a Cloudflare account)