Ir al contenido

Contribución

¡Damos la bienvenida a contribuciones de todo tipo! Ya sea que estés corrigiendo un error, mejorando la documentación o añadiendo una nueva característica, tu ayuda es apreciada.

Para comenzar con el desarrollo, clona el repositorio e instala las dependencias:

Ventana de terminal
git clone https://github.com/fco-gt/gopotency
cd gopotency
go mod download

Incluimos un Makefile para simplificar las tareas comunes de desarrollo.

ComandoDescripción
make testEjecuta todas las pruebas unitarias con el detector de carreras activado.
make benchEjecuta todos los benchmarks de rendimiento.
make buildCompila todas las aplicaciones de ejemplo en el directorio examples/.
make lintEjecuta el linter (requiere golangci-lint).
make helpMuestra una lista de todos los comandos disponibles.
  1. Crear una Rama: Usa un nombre descriptivo como feature/nuevo-almacenamiento o fix/error-tipografico.
  2. Escribir Pruebas: Asegúrate de que tus cambios estén cubiertos por pruebas unitarias.
  3. Ejecutar Benchmarks: Si tu cambio afecta el flujo principal, ejecuta make bench para asegurar que no haya regresiones de rendimiento.
  4. Pasar el CI: GitHub Actions ejecutará automáticamente make test y make build en tu PR.
  5. Solicitar Revisión: Una vez que las comprobaciones pasen, espera a que un mantenedor revise tu código.