Skip to content

docs(readme): add project quickstart and contributing guide - #72

Merged
MrDylanDev merged 2 commits into
mainfrom
docs/readme
Aug 13, 2026
Merged

docs(readme): add project quickstart and contributing guide#72
MrDylanDev merged 2 commits into
mainfrom
docs/readme

Conversation

@MrDylanDev

Copy link
Copy Markdown
Owner

Closes #64

Summary

  • README.md: stack, arquitectura resumida, quickstart de desarrollo (compose + datos seed con credenciales reales), cómo correr tests backend y E2E, despliegue productivo, CI y referencia a docs/ops/backup-restore.md.
  • CONTRIBUTING.md: flujo completo issue aprobado → rama type/descripcion → PR con Closes #N y etiqueta type:*, checklist del PR, estándares de calidad y comandos útiles.

Todos los comandos y datos fueron verificados contra el repo (Java 17/Spring Boot 3.2, usuarios seed, puertos del compose, jobs del CI, H2 en memoria por defecto sin Compose).

Changes

File Change
README.md Quickstart completo, stack, arquitectura, tests, despliegue prod, CI, docs
CONTRIBUTING.md Flujo de contribución, convenciones de ramas/commits/labels, estándares

Test Plan

  • Comandos verificados contra el repo (no inventados): ./mvnw test, ./mvnw -Pcoverage verify, E2E según requirements.txt, prod según .env.prod.example
  • Credenciales seed exactas desde conftest.py y los initializers
  • Estados reales de préstamo/libro documentados (no asumidos)
  • Solo docs — no afecta tests ni build

Checklist

  • Issue aprobado vinculado (status:approved)
  • Label type:docs
  • Conventional commit
  • Sin Co-Authored-By
@MrDylanDev
MrDylanDev merged commit 2417128 into main Aug 13, 2026
3 checks passed
@MrDylanDev
MrDylanDev deleted the docs/readme branch August 13, 2026 03:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

1 participant