Introducción
Puedes utilizar los repositorios de GitHub, las propuestas, los tableros de proyecto y otras herramientas para rastrear y planear tu trabajo, ya sea que trabajes en un proyecto individual o en un equipo inter-funcional.
En esta guía, aprenderás cómo crear y configurar un repositorio para colaborar con un grupo de personas, crear plantillas de propuestas, abrir propuestas y utilizar las listas de tareas para dividir el trabajo y establecer un tablero de proyecto para organizar y rastrear las propuestas.
Crear un repositorio
Cuando comienzas un proyecto, inciativa o característica nuevos, el primer paso es crear un repositorio. Los repositorios contienen todos los archivos de tu proyecto y te proporcionan un lugar para colaborar con otros y administrar tu trabajo. Para obtener más información, consulta la sección "Crear un nuevo repositorio."
Puedes configurar repositorios para propósitos diferentes con base en tus necesidades. Los siguientes son algunos casos de uso común:
- Repositorios de producto: Las organizaciones más grandes que rastrean su trbaajo y metas en productos específicos tienen uno o más repositorios que contienen el código y otros archivos. Estos repositorios también pueden utilizarse para documentación, reportes sobre la salud de los productos o planes futuros para estos.
- Repositorios de proyecto: Puedes crear un repositorios para un proyecto individual en el cual estés trabajando o para uno en el que estés colaborando con otras personas. Para una organización que rastrea el trabajo para iniciativas o proyectos de vida corta, tales como una firma de consultores, se necesita reportar la salud de un proyecto y mover a las personas entre proyectos diferentes con base en sus habilidades y necesidades. El código del proyecto a menudo se contiene en un solo repositorio.
- Repositorios de equipo: Para una organización que agrupa a las personas en equipos y les da proyectos, tales como un equipo de herramientas de desarrollo, el código puede repartirse en muchos repositorios para lso diferentes trabajos que tienen que rastrear. En este caso, puede se útil tener un repositorio específico para cada equipo como lugar único para rastrear todo el trabajo en el que se involucra dicho equipo.
- Repositoris personales: Puedes crear un repositorio personal para rastrear todo tu tabajo en un solo lugar, planear tareas a futuro o incluso agregar notas o información que quieras guardar. También puedes agregar colaboradores si quieres compartir esta información con otros.
Puedes crear repositorios múltiples y separados si quieres tener permisos de acceso diferentes para el código fuente y para rastrear propuestas y debates. Para obtener más información, consulta la sección "Crear un repositorio solo para propuestas".
Para los ejemplos siguientes en esta guía, utilizaremos un repositorio de ejemplo llamado Proyecto Octocat.
Comunicar la información del repositorio
Puedes crear un archivo de README.md para tu repositorio e introducir tu equipo o proyecto y comunicar información importante sobre este. A menudo, un README es el primer elemento que verá un visitante de tu repositorio, así que también puedes proporcionar información de cómo los usuarios o contribuyentes pueden iniciar con el proyecto y de cómo contactar al equipo. Para obtener más información, consulta "Acerca de los README".
También puedes crear un archivo de CONTRIBUTING.md, específicamente para que contenga los lineamientos sobre cómo los usuarios o contribuyentes pueden interactuar o contribuir con el proyecto, con instrucciones tales como cómo abrir una propuesta para arreglar un error o cómo solicitar una mejora. Para obtener más información, consulta "Establecer pautas para los colaboradores del repositorio".
Ejemplo de README
Podemos crear un README.md para introducir nuestro proyecto nuevo al Proyecto Octocat.
Crear plantillas de reporte de problemas
Puedes utilizar las propuestas para rastrear los tipos de trabajo diferentes que tu equipo o proyecto inter-funcional cubre, así como para recopilar información de aquellos fuera de tu proyecto. Los siguientes son algunos casos de uso comunes para las propuestas.
- Liberar el rastreo: Puedes utilizar una propuesta para rastrear el progreso para un lanzamiento o para los pasos a completar el día del lanzamiento.
- Iniciativas grandes: Puedes utilizar una propuesta para rastrear el progreso en un proyecto de iniciativa grande, el cual se enlaza a propuestas más pequeñas.
- Solicitudes de características: Tu equipo o usuarios pueden crear propuestas para solicitar una mejora en tu producto o proyecto.
- Errores: Tu equipo o usuarios pueden crear propuestas para reportar un error.
Dependiendo del tipo de repositorio y proyecto en el que estés trabajando, podrías priorizar ciertos tipos de propuestas osbre otras. Una vez que hayas identificado los tipos de propuesta más comunes para tu equipo, puedes crear plantillas de propuestas para tu repositorio. Las plantillas de propuestas te permiten crear una lista estandarizada de plantillas de las cuales puede elegir un contribuyente para abrir una propuesta en tu repositorio. Para obtener más información, consulta "Configurar plantillas de propuestas para tu repositorio".
Ejemplo de plantilla de propuesta
A continuación, creamos una plantilla de propuesta para reportar un error en el Proyecto Octocat.
Ahora que creamos la plantilla de propuestas para reportes de errores, puedes seleccionarla cuando crees una propuesta nueva en el proyecto Octocat.
Abrir propuestas y utilizar las listas de tareas para rastrear el trabajo
Puedes organizar y rastrear tu trabajo creando propuestas. Para obtener más información, consulta la sección "Crear una propuesta".
Ejemplo de propuesta
Aquí tienes un ejemplo de una propuesta que se creó para un trabajo de cara al usuario de una iniciativa grande en el proyecto Octocat.
Ejemplo de lista de tareas
Puedes utilizar listas de tareas para dividir propuestas más grandes en otras más pequeñas y para rastrear propuestas como parte de una meta más grande. Para obtener más información, consulta la sección "Acerca de las listas de tareas".
Debajo, agregamos una lista de tareas a nuestra propuesta del Proyecto Octocat, dividiéndola en propuestas más pequeñas.
Tomar deciciones como equipo
Puedes utilizar las propuestas y debates para comunicarte y hacer decisiones como equipo sobre las mejoras planeadas o sobre las prioridades de tu proyecto. Las propuestas son útiles cuando las creas para debatir detalles específicos, tales como reportes de rendimiento o de errores, planeaciones para el siguiente trimestre o diseño para una iniciativa nueva. Los debates son útiles para la lluvia de ideas abierta o para la retroalmientación, fuera de la base de código y a través de los repositorios. Para obtener más información, consulta la sección "¿Qué herramienta de debate debería utilizar?".
Como equipo, puedes comunicar actualziaciones sobre las tareas del día a día dentro de las propuestas para que todos sepan el estado del trabajo. Por ejemplo, puedes crear una propuesta para una característica grande en la que estén trabajando varias personas y cada miembro puede agregar actualizaciones con su estado o preguntas abiertas en esa propuesta.
Ejemplo de propuesta con colaboradores de proyecto
Aquí tienes un ejemplo de los colaboradores de proyecto dando una actualización de estado sobre su trabajo en la propuesta del Proyecto Octocat.
Utilizar etiquetas para resaltar las metas y el estado del proyecto
Puedes crear etiquetas para que un repositorio categorice las propuestas, solicitudes de cambio y debates. GitHub también proporciona etiquetas predeterminadas para cada repositorio nuevo que puedas editar o borrar. Las etiquetas sirven para rastrear las metas del proyecto, los errores, los tipos de trabajo y el estado de una propuesta.
Para obtener más información, consulta "Crear una etiqueta".
Una vez que hayas creado una etiqueta en un repositorio, puedes aplicarla a cualquier propuesta, solicitud de cambos o debate en este. Puedes entonces filtrar las propuestas y solicitudes de cambio por etiqueta para encontrar todo el trabajo asociado. Por ejemplo, encuentra los errores de cara al usuario en tu proyecto filtrando las propuestas con las etiquetas front-end y bug. Para obtener más información, consulta la sección "Filtrar y buscar las propuestas y solicitudes de cambio".
Ejemplo de etiqueta
A continuación se encuentra un ejemplo de una etiqueta de front-end que creamos y agregamos a la propuesta.
Agregar propuestas a un tablero de proyecto
También puedes utilizarlos tableros de proyecto en GitHub para planear y rastrear tu trabajo o el de tu equipo. Los tableros de proyecto están compuestos por propuestas, solicitudes de extracción y notas que se categorizan como tarjetas en columnas a tu elección. Puedes crear tableros de proyecto para presentar trabajo, planes de alto nivel o incluso listas de verificación. Para obtener más información, consulta "Acerca de los tableros de proyectos."
Ejemplo del trablero de proyecto
A continuación, se presenta un tablero de proyecto para nuestro ejemplo del Proyecto Octocat, con la propuesta que creamos y las propuestas más pequeñas en las que lo dividimos agregadas a este.
Pasos siguientes
Ya aprendiste sobre las herramientas que ofrece GitHub para planear y rastrear tu trabajo e iniciaste en la configuración de un equipo inter-funcional o repositorio de proyecto. Aquí te mostramos algunos recursos útiles para seguir personalizando tu repositorio y organizar tu trabajo.
-
Consulta la sección "Acerca de los repositorios" para aprender más sobre cómo crear los repositorios
-
"Rastrear tu trabajo con propuestas" para aprender más sobre los tipos diferentes de crear y administrar las propuestas
-
"Acerca de las propuestas y solicitudes de cambios" para aprender más sobre las plantillas de propuestas
-
"Administrar etiquetas" para aprender cómo crear, editar y borrar etiquetas
-
"Acerca de las listas de tareas" para aprender más sobre las tareas
-
"Acerca de los tableros de proyecto" para aprender cómo administrar los tableros de proyecto