- Sobre Activando Ideas
- ¿Listo para contribuir?
- Consejos útiles para colaborar
- Guía de contribución en GitHub
- Convensiones para los repositorios
- Guía de creación de proyectos
Activando Ideas es una comunidad que busca compartir y desarrollar recursos de código abierto en temas de Ciencia de Datos, Estadística, Inteligencia Artificial, Backend, Frontend, Cloud y DevOps con el objetivo de que puedan ser de ayuda al momento de desarrollar proyectos.
- Lee la públicación en Activando Ideas:
- Únete a la discusión por discord para contribuir con nuevas ideas
En activando ideas se realizó un post que se actualiza constantemente con algunos tips para usar GitHub, puedes revisarlo aquí:
https://activandoideas.com/blog/desarrollo/github-la-red-social-de-los-programadores
¡Las contribuciones son bienvenidas y muy apreciadas! Todo ayuda, y siempre se le dará crédito. Puedes contribuir de muchas formas:
Reporta el Bug, creando un issue en el repositorio
Por favor incluye:
- El nombre y la versión de su sistema operativo
- Cualquier detalle sobre su configuración local que pueda ser útil para solucionar problemas.
- Pasos detallados para reproducir el error..
Busca los issues con bugs. Todo lo etiquetado con "bug" y "help wanted" está abierto a quien quiera implementarlo.
Busca los issues para features. Todo lo tagueado con "enhancement" y "help wanted" está abierto a quien quiera implementarlo.
Cada proyecto siempre puede requerir más documentación, ya sea como parte de los documentos oficiales, en cadenas de documentos o incluso en la web en publicaciones de blogs, artículos, etc.
La mejor forma de enviar feedback es creando un nuevo issue. Sí estás proponiendo un nuevo feature:
- Explique en detalle cómo funcionaría.
- Mantenga el alcance lo más delimitado posible para que sea más fácil de implementar.
- Recuerde que este es un proyecto impulsado por voluntarios y que las contribuciones son bienvenidas :)
- Realiza un Fork del repositorio.
- Clonalo localmente
- Realiza los pasos de instalación descritos en el repositorio
- Crea un nuevo branch para desarrollar localmente:
git checkout -b name-of-your-bugfix-or-featureAhora puedes hacer tus cambios localmente
-
Cuando haya terminado de realizar cambios, verifique que sus cambios pasen las pruebas de los linters y tests
-
Realiza un commit de tus cambios y haz un push push de tu rama a GitHub
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature- Envia tu pull request
Antes de enviar una solicitud de extracción, verifique que cumpla con estas pautas:
- La solicitud de extracción debe incluir tests.
- Si la solicitud de extracción agrega funcionalidad, los documentos deben actualizarse. Coloque su nueva funcionalidad en una función con una cadena de documentos y agregue la función al README.md
- Los pull request deberían funcionar para las últimas versiones del lenguaje del repositorio
- Asegurese de que las pruebas de CI se ejecuten correctamente
Un recordatorio para los mantenedores sobre cómo implementar. Asegúrese de que todos sus cambios estén confirmados (incluida una entrada en CHANGELOG.md)
Describa la versión: major / minor / patch
git push
git push --tags
Conventional Commits
https://www.conventionalcommits.org/en/v1.0.0
GitFlow
https://danielkummer.github.io/git-flow-cheatsheet/
- Crear un repositorio o repositorios para el proyecto
- Crear un proyecto a nivel de organización
- Poner un nombre claro y especifico, elige el template con automatizaciones
- Agrega los repositorios creados al proyecto, que van a ser dependientes
Presiona ? para ver la lista de cosas que puedes hacer de forma rápida
Cada una de las tarjetas serán automatizadas según los criterios
- Backlog: (Renombrada de ToDo) Tareas por hacer en el Sprint definido por el equipo
- Se agregan con un Issue
- In progress: Tareas que se están haciendo actualmente
- se agrega al enviar un Pull request
- Testing: Tareas en proceso de pruebas
- Se agrega al ser aprobado o enviado por un revisor
- Done: Tareas realizadas
- Se ajusta cuando se hace Merge o se cierra el issue
- Los Issues son tareas generales que se crean en el Backlog, lo que queda por hacer
- Los Pull Request son tareas especificas para cumplir con lo que requiere el issue creado y va cambiando de estado en el tiempo
En el repositorio correspondiente agregar un nuevo issue, está es la tarea general en la que pueden trabajar una o más personas y en ella generar los PR correspondientes para concretarlo
Para ello es importante asignar lo siguiente según sea necesario:
- Título claro para comprender claramente el objetivo de la tarea
- Descripción de la tarea incorporando mayores detalles
- Etiquetas para clasificar los proyectos e indicar de que se trata la tarea
- Milestones para establecer hitos/deadlines con fechas específicas a cumplir en el equipo
- Proyecto selecciona el proyecto al que pertenece la tarea para que se agregue al backlog
El issue deberá verse como sigue:
Al publicar el issue quedará como tarea en el proyecto
Generar un nuevo pull request en otra rama
Se envia la petición para hacer merge, se puede asignar a la persona que va a hacer la revisión, para que se apruebe si el cambio puede influir con el trabajo de otra persona o si hace algo relaciones, se hace referencia al issue al que pertenece, llenando los demás campos
Se enlaza el issue al PR para generar el tracking y se genere como tarea dependiente
Una vez enviado y linkeado el PR se crea en In progress como algo que ya se está haciendo y que depende de un issue
Si no se siguen los pasos correctamente, se pueden duplicar branches, para eliminar innecesarios se puede hacer lo siguiente
En el repositorio seleccionar branches
Eliminar los que se generaron innecesariamente
Tiene que pasar por las validaciones de alguien del equipo y aprobar el PR
Para que la tarjeta se mueva al final, se debe configurar para que se debe hacer merge
- Dependiendo del cambio deberá ser aprobado,
- Se deberan configurar acciones para automatizar algunas tareas y validaciones de código antes del merge para que pueda pasar
Al finalizar los pull request asociados al issue se deberá dar por terminado el issue
Una vez concluida el issue parará a Done
