Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (36 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

55 lines (36 loc) · 2.8 KB
Raw

Contribuir a este fork de models.dev

Propósito de este documento

  • Objetivos: Explicar setup, flujo de rama/PR y reglas para contribuir al catálogo sin reescribir el producto ni el dataset.
  • Estructura: Idioma → setup → flujo de trabajo → comprobaciones antes del PR → reglas.
  • Contenido a integrar según contexto: Adapta Bun y bun validate de este repo. No copies un flujo pnpm/monorepo. El detalle de TOML, base_model y el esquema vive en README.md y AGENTS.md.

Idioma: este fichero, SECURITY.md y el aviso de fork del README en español. Identificadores de CI y nombres de jobs en inglés (quality, test, smoke). La guía de datos del README (secciones API / Contributing / Schema) se conserva en inglés, como en el upstream.

Lee también AGENTS.md (contrato del catálogo) y SECURITY.md.

Este repositorio es un fork

Alexendros/models.dev parte de anomalyco/models.dev. La rama por defecto es dev. No clones a ciegas el canon de producto: no actives deploy, sync horario ni publicación del SDK en este fork.

Setup

bun install

Requiere Bun.

Flujo de trabajo

Rama feat/* / fix/* / docs/* / chore/* → PR contra dev. Los agentes Cloud usan cursor/….

Cambios de catálogo (TOML de labs o providers) siguen las reglas de AGENTS.md: base_model si el host no creó el modelo; fichero de lab completo si falta; costes en USD/MTok.

Antes de un PR

bun validate
bun test packages/core/test/schema.test.ts packages/core/test/auto-merge.test.ts packages/core/test/family.test.ts packages/core/test/empiriolabs.test.ts packages/sdk/test/client.test.ts packages/sdk/test/effect.test.ts
  • bun validate — valida el catálogo contra el esquema (job CI quality).
  • El job CI test corre un subconjunto unitario (schema, helpers, cliente SDK). El bun test completo del workspace incluye auditorías del dataset vivo y el snapshot generado del SDK; hoy fallan en el dev del upstream y no se reescriben en este fork.
  • El job smoke comprueba que existen los ficheros P0 y que models.json es JSON válido.

Si mueves campos de provider a models/, compara la salida generada:

bun run compare:migrations

Reglas

  • No reescribas el frontend, el dataset ni el generador salvo que el cambio sea el objeto del PR.
  • No pises LICENSE (MIT del proyecto original).
  • Conventional Commits. Cuerpo y docs de gobernanza en español; IDs de modelo y campos TOML en inglés.
  • Vulnerabilidades: SECURITY.md, no un issue público.
  • Sin secretos, .env ni claves de Cloudflare/npm en el diff.
  • Los workflows Deploy, Sync Model Catalogs y Publish SDK permanecen gated a anomalyco/models.dev.