Skip to content

docs: preparar el README y la política de seguridad para el repo público - #4

Merged
mijhaels merged 2 commits into
mainfrom
docs/readme-publico
Oct 14, 2026
Merged

mijhaels merged 2 commits into
mainfrom
docs/readme-publico

Conversation

@mijhaels

@mijhaels mijhaels commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Requested by ith

Summary

Revisión del README antes de abrir el repo, con las reglas de redacción del skill writing-for-interfaces (motivo antes de la instrucción, nada de relleno, nombres concretos).

 # @sifende/sdk
+## Instalación          # npm install, prefijos de API key, link a la doc
 ## Uso                  # define pedidoId; explica cómo llega el resultado
+## Configuración        # timeoutMs, maxReintentos, baseUrl, fetch
 ## Operaciones          # una fila por método, rutas completas
 ## Errores              # reintentos en lista; SifendeTimeoutError
 ## Webhooks             # tipos de evento y tolerancia del timestamp
 ## Desarrollo
 ## Licencia
  • El ejemplo de uso referenciaba pedido.id sin definirlo: copiado tal cual, fallaba.
  • consultarConsumoPlan() figuraba como /plan-consumo; la ruta real es /api/v1/contribuyente/plan-consumo (src/recursos/contribuyente.ts:20).
  • consultarEvento(id) compartía fila con listarEventos y no mostraba /eventos/{id}.
  • Los datos nuevos (valores por defecto, 3 minutos del KuDE, 5 minutos de tolerancia, tipos de evento) salen de src/http.ts, src/recursos/documentos.ts y src/webhooks.ts.

Además agrega SECURITY.md: los reportes de vulnerabilidades van por el reporte privado de GitHub.

Evidence

  • Before: el bloque de uso no compila (pedido no existe).
    After: los tres bloques ts del README, extraídos a archivos temporales e importando ../src/index.js, pasan tsc --noEmit (el único aviso fue isolatedDeclarations sobre la función de ejemplo del webhook, una regla interna del repo). biome check sin cambios.

Merge Danger

Door: two-way

Blast Radius: documentación

Solo cambia el README y agrega SECURITY.md. En npm sigue el README de 0.1.0 hasta la próxima versión publicada.

🤖 Generated with Claude Code

Agrega instalación y configuración, define la variable que faltaba en el
ejemplo, separa las filas ambiguas de la tabla de operaciones y ordena cada
párrafo con el motivo antes de la instrucción.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@mijhaels mijhaels self-assigned this Oct 14, 2026
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@mijhaels mijhaels changed the title docs: preparar el README para el repo público docs: preparar el README y la política de seguridad para el repo público Oct 14, 2026
@mijhaels
mijhaels merged commit 230b14e into main Oct 14, 2026
2 checks passed
@mijhaels
mijhaels deleted the docs/readme-publico branch October 14, 2026 19:24
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