Skip to content

Enfoca el README del SDK Java en quienes usan la biblioteca - #2

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
Contributor

Summary

El README empezaba con la compilación, Spotless y PMD, y mezclaba las dependencias del build con el uso. Ahora sigue el recorrido de quien consume la biblioteca.

 README.md
+  Requisitos · Instalación (includeBuild)
   Uso
+    Respuestas   # campos de Contribuyente y SearchResponse
+    Errores      # HTTP vs IOException
+    Timeouts     # 60 s por defecto y constructor con valores propios
   Migración desde 0.0.1-beta
-  Requisitos y compilación
-  Formato y análisis estático
-  Dependencias   # detalle de BOM, api vs implementation
+CONTRIBUTING.md  # compilación, calidad, CI y dependencias

Documenta dos comportamientos del código que no aparecían:

  • el timeout de 60 s y el constructor TuRuc(url, call, write, read, connect);
  • que el cliente registra cada petición y respuesta completas en el log de OkHttp (HttpLoggingInterceptor.Level.BODY).

Evidence

  • Before: quien consumía la biblioteca no encontraba los timeouts, el formato de error ni el logging sin leer TuRuc.java.
    After: el README los documenta, y los nombres y el orden de los campos coinciden con Contribuyente.java.

Merge Danger

Door: two-way

Solo cambia documentación.

Blast Radius: Documentación

🤖 Generated with Claude Code

Move build, quality and dependency notes to CONTRIBUTING.md. Document
the response fields, error handling, timeouts and request logging that
consumers rely on.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mijhaels
mijhaels merged commit c1b4b97 into main Oct 12, 2026
6 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