Cómo ayudar

Ayuda con issues, revisión de texto, traducciones, pruebas de modelos y pull requests.

Pepe es un proyecto joven. La ayuda pequeña y enfocada ya cuenta: abrir una issue clara, responder dudas, revisar textos, probar proveedores, mejorar traducciones o enviar un PR.

Formas útiles de ayudar

Del fork al PR

  1. Haz un fork en GitHub.
  2. Clona tu fork:
git clone git@github.com:TU_USUARIO/pepe.git
cd pepe
  1. Añade el repositorio original como upstream:
git remote add upstream https://github.com/pepe-agent/pepe.git
git fetch upstream
  1. Crea una rama desde master:
git checkout -b docs-mejora-quickstart upstream/master
  1. Instala dependencias y ejecuta las pruebas:
mix deps.get
mix test
  1. Si vas a cambiar el website:
cd website
npm install
npm run dev
  1. Haz el cambio. Para docs y textos, revisa también los otros idiomas cuando la misma página exista en ellos.

  2. Ejecuta la verificación final desde la raíz:

mix precommit
  1. Haz commit y sube la rama a tu fork:
git add .
git commit -m "Improve quickstart copy"
git push origin docs-mejora-quickstart
  1. Abre un pull request contra pepe-agent/pepe:master. Explica qué cambió, por qué cambió y enlaza la issue si existe.

Buenos PRs

Un buen PR es pequeño, tiene alcance claro y facilita la revisión. Para código, incluye una prueba cuando cambie comportamiento. Para documentación, prefiere frases cortas, ejemplos reales y enlaces a páginas más profundas antes que repetir todo.

Ayuda con modelos

Los informes de proveedores son muy útiles. El informe ideal incluye:

Si algo falla, abre una issue con ese contexto. Incluso un “probado y funciona” ayuda a saber qué integraciones están sanas.