Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (26 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

35 lines (26 loc) · 1.28 KB
Raw

CONTRIBUTING.md

Gracias por interesarte en contribuir a este proyecto. A continuación indicaciones básicas para contribuir de forma ordenada.

  1. Reportar issues
  • Abre un issue claro y reproducible indicando objetivo, pasos para reproducir y, si procede, archivos de ejemplo.
  1. Workflow de PR
  • Crea una rama a partir de main: git checkout -b feat/mi-cambio
  • Haz commits atómicos y con mensajes claros (imperativo): "Add X", "Fix Y"
  • Abre un Pull Request describiendo cambios y objetivos. Vincula issues si procede.
  1. Estilo de código y calidad
  • Python: seguir PEP8. Recomendado usar black/isort/flake8.
  • Notebooks: limpiar salidas antes de commitear (nbstripout o manualmente).
  1. Entorno y deps
  • Usa un entorno virtual (ver README).
  • Instala dependencias de desarrollo si las hay (requirements_dev).
  1. Tests
  • Añade tests para cambios relevantes en MODULOS/MYLIBS cuando sea posible.
  • Ejecuta pytest localmente antes de subir PR.
  1. Pre-commit y nbstripout (recomendado)
  • Instalar pre-commit y nbstripout: pip install pre-commit nbstripout pre-commit install nbstripout --install --attributes .gitattributes
  1. Licencias y datasets
  • Si añades datos, incluye su licencia o permiso de uso dentro de DATASETS/ y no subas datos sensibles.

Contacto