Skip to content

docs: dev setup + Contributing in root README#5

Merged
antuuanyf merged 2 commits into
mainfrom
docs/dev-setup
May 30, 2026
Merged

docs: dev setup + Contributing in root README#5
antuuanyf merged 2 commits into
mainfrom
docs/dev-setup

Conversation

@antuuanyf

@antuuanyf antuuanyf commented May 30, 2026

Copy link
Copy Markdown
Owner

Documenta en el README raíz cómo levantar el repo desde un clon limpio y cómo contribuir.

Dev setup (clon limpio)

  • Dónde correr npm install: dos sitios.
    • Raíz: cubre los dos paquetes (packages/core, packages/angular) por ser workspaces.
    • demos/angular: install aparte — no es workspace; consume los paquetes construidos vía file: deps.
  • Orden: build:angular antes de instalar la demo (su file: apunta a packages/angular/dist).
  • Scripts npm test y npm run test:e2e.

Contributing

  • Flujo branch + PR a main (sin commits directos), PRs enfocados.
  • Gate previo al push: npm run build && npm test && npm run test:e2e.
  • Convenciones clave (GSAP peer dep, SSR-safe, tipos por JSDoc, wrapper standalone), enlazando a AGENTS.md para el detalle.

🤖 Generated with Claude Code

antuuanyf and others added 2 commits May 30, 2026 17:58
Spell out the two npm install locations for new contributors: one at the
repo root (covers both workspace packages) and a separate one in
demos/angular, which isn't a workspace and consumes the built packages
via file: deps — so build:angular must run before installing the demo.
Also list the test / test:e2e scripts.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Summarize the branch + PR workflow, the pre-push build/test gate, and the
key core/Angular conventions, linking to AGENTS.md for the full rules.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@antuuanyf antuuanyf changed the title docs: document fresh-clone dev setup docs: dev setup + Contributing in root README May 30, 2026
@antuuanyf antuuanyf merged commit 155064a into main May 30, 2026
1 check passed
@antuuanyf antuuanyf deleted the docs/dev-setup branch May 30, 2026 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant