Angular-dragdrop es una biblioteca de código abierto que integra funcionalidades de arrastre y suelta de jQueryUI en aplicaciones AngularJS, con soporte para animaciones. Esta guía detalla el flujo de trabajo para contribuir al proyecto, desde la preparación del entorno hasta la integración de cambios.
Preparación del Entorno de Desarrollo
Asegúrese de tener instalados los siguientes requisitos previos:
- Git para el control de versiones
- Node.js con npm (gestor de paquetes)
- Bower para la gestión de dependencias del lado del cliente
Obtención del Código Fuente
Clone el repositorio del proyecto usando Git. Ejecute el siguiente comando en su terminal:
git clone https://github.com/user/angular-dragdrop.git
cd angular-dragdrop
Esto creará un directorio local con el código completo, donde se realizarán todas las modificaciones.
Instalación de Dependencias
El proyecto requiere varias bibliotecas para su desarrollo y pruebas. Instale las dependencias ejecutando estos comandos en la raíz del proyecto:
npm install -g karma-cli
npm install
bower install --latest
Los archivos package.json y bower.json contienen la lista completa de dependencias necesarias.
Estructura del Proyecto
La organización del código es clave para localizar archivos relevantes:
- src/: Directorio con el código fuente principal, incluyendo
angular-dragdrop.jsy su versión minificada. - test/: Contiene los scripts de prueba, como
spec/tests.js. - demo/: Páginas de ejemplo que ilustran el uso de las funciones de arrastre.
- Gruntfile.js: Configuración de tareas de automatización, como la miniifcación.
- karma.conf.js: Configuración del marco de pruebas Karma.
Desarrollo de Correcciones o Nuevas Funcionalidades
Antes de modificar el código, cree una rama aislada para su trabajo:
git checkout -b fix/issue-123
Los cambios principales se aplican en src/angular-dragdrop.js. Si implementa una nueva característica, actualice o cree archivos de demostración en demo/ para documentar su uso.
Ejecución de Pruebas
Valide que sus cambios no introducen errores ejecutando la suite de pruebas:
npm test
Las pruebas utilizan Jasmine y se ejecutan mediante Karma. Un resultado exitoso indica que la funcionalidad existente no se ha copmrometido.
Envío de Contribuciones
Una vez completado el desarrollo y verificadas las pruebas, siga estos pasos para enviar sus cambios:
- Registre los archivos modificados y cree un commmit con un mensaje descriptivo:
git add .
git commit -m "Corregir comportamiento en arrastre condicional"
- Suba su rama al repositorio remoto:
git push origin fix/issue-123
- Abra una solicitud de extracción (Pull Request) en el repositorio del proyecto para la revisión por parte de los mantenedores.
Recomendaciones para Contribuciones
- Mantenga la coherencia con el estilo de código existente.
- Incluya pruebas para cualquier funcionalidad nueva.
- Verifique que todas las pruebas pasan antes de enviar los cambios.
- Proporcione una descripción clara en el mensaje del commit y en la solicitud de extracción.