Cómo ayudar

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

Pepe todavía es un proyecto joven, así que hasta una ayuda pequeña y puntual ya suma: abrir una issue clara, contestar dudas, revisar textos, probar un proveedor, afinar una traducción o mandar un PR.

Formas útiles de ayudar

Del fork al PR

  1. Haz un fork del repositorio en GitHub.
  2. Clona tu fork:
git clone git@github.com:TU_USUARIO/pepe.git
cd pepe
  1. Agrega el repositorio original como upstream:
git remote add upstream https://github.com/pepe-agent/pepe.git
git fetch upstream
  1. Crea una rama a partir de master:
git checkout -b docs-mejora-quickstart upstream/master
  1. Instala las dependencias y corre las pruebas:
mix deps.get
mix test
  1. Si vas a tocar el sitio web:
cd website
npm install
npm run dev
  1. Haz el cambio. Si es documentación o texto, revisa también las otras páginas del mismo idioma y, cuando la página exista en más de un idioma, échales un vistazo también.

  2. Antes de subir nada, corre la verificación final desde la raíz del proyecto:

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, explicando qué cambiaste y por qué, con un enlace a la issue correspondiente si la hay.

Qué hace bueno a un PR

Uno pequeño, con un alcance claro, es el que se revisa más rápido. Si tocas código, suma una prueba cuando el comportamiento cambie. Si es documentación, prefiere frases cortas, ejemplos reales, y enlazar a la página que profundiza en vez de repetir todo ahí mismo.

Ayuda probando modelos

Los reportes sobre proveedores valen oro. Uno ideal trae:

Si algo falla, abre una issue con ese mismo contexto. Incluso un simple “lo probé y funciona” ayuda a saber qué integraciones están sanas y cuáles no.