Skip to content

Enfoca el README del SDK JavaScript en quienes usan la biblioteca - #7

Merged
mijhaels merged 1 commit into
mainfrom
docs/readme-para-usuarios
Oct 12, 2026
Merged

mijhaels merged 1 commit into
mainfrom
docs/readme-para-usuarios

Conversation

@mijhaels

Copy link
Copy Markdown
Collaborator

Summary

El README mezclaba el uso de la biblioteca con detalles de lint, CI y publicación que no le sirven a quien la instala desde npm.

 README.md
   Requisitos · Instalación · Uso
+  Datos del contribuyente   # campos devueltos
+  Errores                   # ValidationError / ServerError, cómo distinguirlos
-  Desarrollo                # Oxlint, Oxfmt, ESLint, JSDoc
-  Publicación               # workflow CI/CD, NPM_TOKEN
+CONTRIBUTING.md             # Desarrollo + Publicación, sin perder información

También corrige la documentación de getContribuyenteByRucOrCI: decía "entre 3 y 10 caracteres", pero el código acepta una CI de hasta 8 dígitos con dígito verificador opcional.

Evidence

  • Before: el ejemplo del README falla la validación:
    getContribuyenteByRucOrCI('1234567890') -> ValidationError: El parámetro ruc es inválido. Debe tener formato 12345 o 123456-1
    
    After: el ejemplo usa 80024191-6, que cumple el formato.
  • npm run format:check, npm run lint y npm run test:package pasan.

Merge Danger

Door: two-way

Solo cambia documentación.

Blast Radius: Documentación

La página del paquete en npm muestra el README nuevo cuando se publique la próxima versión.

🤖 Generated with Claude Code

Move development, lint and release instructions to CONTRIBUTING.md.
Document the accepted RUC/CI format, the returned fields and the error
types, and fix the RUC example, which failed validation.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mijhaels
mijhaels merged commit 7e4c8ea into main Oct 12, 2026
3 checks passed
@mijhaels
mijhaels deleted the docs/readme-para-usuarios branch October 27, 2026 15:15
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