GitHub se ha convertido en el epicentro del desarrollo colaborativo de software en la era digital. Es más que una plataforma de alojamiento de código; es una comunidad global donde los desarrolladores pueden colaborar, aprender y construir juntos. En este artículo, exploraremos cómo puedes iniciar y mantener un proyecto exitoso en GitHub, desde la concepción de la idea hasta la contribución activa.
Comenzando en GitHub: Creación de Cuenta y Primeros Pasos
Para sumergirte en el mundo de GitHub, necesitas crearte la cuenta. GitHub proporciona toda su funcionalidad en cuentas gratuitas, puedes tener tanto proyectos públicos como privados ilimitados.
Configuración de la Cuenta
Al configurar tu perfil, puedes personalizarlo con una imagen de tu elección. Además, es fundamental gestionar la dirección de correo electrónico asociada a tu cuenta. En Añadiendo direcciones de correo podemos ver los diferentes estados posibles:
- Una dirección de correo electrónico principal significa que es donde vas a recibir cualquier notificación.
- Si una dirección no es la principal, significa que no puedes usarla como principal si quieres cambiarla.
Si prefieres usar SSH, necesitas configurar una clave pública. Asegúrate de darle a tu clave un nombre que puedas recordar. Es también popular la verificación de Dos Pasos o “2FA” para reducir el riesgo de que te roben la cuenta.
Del Concepto a la Creación del Repositorio
Antes de sumergirte en el mundo de GitHub, es fundamental tener una idea clara de tu proyecto. ¿Qué problema resolverá? ¿Cuál es su propósito? ¿Quién será tu audiencia objetivo? Responder estas preguntas te ayudará a definir el alcance y los objetivos de tu proyecto.
Lea también: Guía de la Oficina Recaudadora de Cholula
Creación de tu Repositorio
Una vez que tengas una idea clara, es hora de crear tu repositorio en GitHub. Para ello, inicia sesión en tu cuenta de GitHub y haz clic en el botón verde «Nuevo» en la esquina superior derecha de tu perfil. Aquí puedes darle un nombre descriptivo a tu repositorio, agregar una descripción concisa y seleccionar si deseas que sea público o privado.
Es importante conocer la diferencia entre los tipos de repositorios:
- En GitHub, un repositorio público es visible para cualquier persona y permite que cualquiera clone, bifurque (fork) y contribuya al proyecto.
- Por otro lado, un repositorio privado solo es accesible para los colaboradores que has invitado y proporciona un mayor control sobre quién puede ver y contribuir al proyecto.
Configurando tu Proyecto para la Colaboración
Ahora que tienes tu repositorio creado, es importante configurarlo correctamente para que otros puedan entender tu proyecto y contribuir a él.
Archivo README.md
Uno de los primeros pasos es crear un archivo README.md. Este archivo actúa como la página de inicio de tu proyecto, proporcionando información básica sobre su propósito, cómo usarlo y cómo contribuir.
Selección de Licencia
Además del README, es crucial elegir una licencia para tu proyecto. La licencia define los términos bajo los cuales otros pueden usar, modificar y distribuir tu código. GitHub ofrece una variedad de opciones de licencia, desde las muy permisivas como la Licencia MIT hasta las más restrictivas como la Licencia GPL.
Lea también: Defensa del Contribuyente
Invitar Colaboradores
Por último, pero no menos importante, considera invitar a colaboradores a tu proyecto. Colaborar con otros desarrolladores no solo enriquecerá tu proyecto con diferentes perspectivas y habilidades, sino que también fomentará un sentido de comunidad en torno a tu trabajo.
Trabajando y Contribuyendo en GitHub
Una vez que tu proyecto esté configurado, es hora de comenzar a trabajar en él. Una buena práctica es utilizar ramas (branches) para trabajar en nuevas características o solucionar problemas sin afectar la rama principal de desarrollo (generalmente llamada «master» o «main»).
Gestión de Problemas (Issues)
Cuando encuentres un problema en tu proyecto o alguien sugiera una mejora, puedes crear un «issue» en GitHub. Los problemas son una forma de realizar un seguimiento de tareas, errores o mejoras pendientes en tu proyecto. Pueden etiquetarse, asignarse a colaboradores específicos y discutirse en detalle antes de abordarlos.
Solicitudes de Extracción (Pull Requests)
Cuando estés listo para incorporar cambios en tu proyecto, puedes crear una «pull request» (solicitud de extracción). Esta es una solicitud para fusionar tus cambios de una rama a otra, por ejemplo, desde una rama de características a la rama principal. Las solicitudes de extracción permiten revisar y discutir los cambios antes de fusionarlos, lo que garantiza la calidad y la coherencia del código.
Flujo de Trabajo para Contribuciones de Código Abierto
El problema común al que se enfrenta un aspirante a contribuidor de proyecto de código abierto es cómo realizar el primer paso desde el fork hasta el pull request. El flujo de trabajo definido en Git hará que tu contribución se vea profesional.
Lea también: Guía para Registrarse como Pequeño Contribuyente
- Forkear el Repositorio: Esto es tan simple como hacer click en un botón de GitHub. Esta es la parte más simple de Git.
- Clonar el Repositorio Forkeado: Navega hasta el repositorio forked (El repositorio ahora se encuentra en tu lista de proyectos en GitHub). Luego debes copiar la ruta url para clonar el repositorio.
- Configurar Upstream: Upstream es necesario para mantener el seguimiento desde tu repositorio al repositorio del proyecto original. Debes tener en cuenta que upstream apunta al repositorio del proyecto original y no a tu repositorio forkeado.
- Crear una Nueva Rama: Es bueno crear una nueva rama cada vez que quieras contribuir, esto nos permite identificar que la rama es para la contribución que se está a punto de hacer. Podría ser tan pequeño como corregir un error tipográfico o tan largo como la implementación de una nueva funcionalidad. Otra parte importante de la creación de ramas es el nombrado; es agradable usar un nombre que un extraño que no sabe nada del repositorio pueda entender fácilmente.
- Realizar y Confirmar Cambios: Trabaja en tu nueva rama, realizando los cambios necesarios para tu contribución.
- Abrir un Pull Request: Al abrir una solicitud de pull request, esperarás que el propietario del proyecto o los miembros les guste lo que ven y los mezclen. Para abrir un pull request, navega hasta el repositorio principal.
Esto es todo.
Manteniendo un Proyecto Exitoso y la Comunidad
Mantener un proyecto exitoso en GitHub va más allá de escribir código. Es importante construir y mantener una comunidad en torno a tu proyecto. Esto implica fomentar la participación, responder preguntas de los colaboradores y agradecer sus contribuciones.
Documentación y Actualizaciones
Además, la documentación es clave para que otros puedan entender y utilizar tu proyecto. Asegúrate de mantenerla actualizada y completa, incluyendo instrucciones claras sobre cómo instalar, configurar y utilizar tu proyecto. Por último, pero no menos importante, asegúrate de realizar actualizaciones regulares en tu proyecto. Esto puede incluir correcciones de errores, mejoras de rendimiento o nuevas características. Mantener tu proyecto activo y en evolución demostrará tu compromiso con su éxito a largo plazo.
Preguntas Frecuentes (FAQs)
¿Cómo puedo aprender a usar Git y GitHub si soy un principiante?
Si eres nuevo en Git y GitHub, te recomendamos comenzar con tutoriales y recursos en línea. La documentación oficial de GitHub es una excelente fuente de información, junto con cursos en plataformas como Udemy, Coursera y YouTube.
¿Qué debo hacer si encuentro un error en un proyecto de GitHub?
Si encuentras un error en un proyecto de GitHub, puedes crear un issue en el repositorio del proyecto. Asegúrate de proporcionar detalles claros sobre el problema que has encontrado, incluyendo pasos para reproducirlo y cualquier información relevante sobre tu entorno de desarrollo.
Monetizando Contribuciones: GitHub Sponsors
Si eres un mantenedor de código abierto, sabes que puede ser difícil obtener reconocimiento (y compensación) por todo tu arduo trabajo. GitHub Sponsors ahora incluye varios países en Latinoamérica. Con un perfil de patrocinadores de GitHub, puedes informar fácilmente a las personas sobre cómo pueden apoyar tu trabajo financieramente.
La misión de GitHub Sponsors es proporcionar oportunidades para participar y construir sobre el código abierto. El advenimiento de los patrocinadores de GitHub y otros modelos de patrocinio de terceros ayuda a nuestra industria a tomar los pasos correctos para hacer posibles las carreras de código abierto.
Las corporaciones como Stripe invierten en proyectos de los que dependen o ayudan a aumentar sus ingresos. Tú has dedicado su tiempo, dinero y energía a apoyar a corporaciones y desarrolladores individuales por muy poca compensación a cambio (a pesar de que puede tener otras responsabilidades, como una familia o un trabajo de tiempo completo). Mientras tanto, las corporaciones bien financiadas usan sus herramientas para ganar aún más dinero. Stripe es una de las pocas organizaciones que lidera la carga de la inversión en proyectos de código abierto.
Creación de un Perfil de Patrocinadores
Crear un perfil de patrocinadores de GitHub es parte del mercadeo y el aumento de la visibilidad de su proyecto para atraer a más partidarios. Aunque el mercadeo puede parecer poco auténtico, la realidad es que un buen mercadeo es vital para la longevidad y el éxito de su proyecto. Piénsalo: si nadie sabe que tu proyecto existe, nunca lo verá. El concepto es similar a escribir buenas pautas de contribución y un buen README. La curaduría de estos documentos ayuda a las personas a comprender los objetivos de su proyecto y cómo pueden involucrarse.
Para habilitar los patrocinadores de GitHub para tu perfil u organización, debes unirte a la lista de espera. La lista de espera existe porque el equipo de patrocinadores de GitHub revisa las aplicaciones para asegurarse de que cumplan con las políticas de GitHub.
Elementos Clave de tu Perfil de Patrocinadores
- Introducción: Utilice este espacio para explicar quién es usted, de qué se trata su proyecto y por qué las personas deben invertir.
- Conozca al equipo (para organizaciones): Para las organizaciones, ¡es bueno destacar a los miembros del equipo que dieron vida a la visión! Puede aportar un elemento más humano al proyecto, inspirando a posibles patrocinadores.
- Niveles de patrocinadores con cantidades y descripciones: Los niveles de patrocinadores producen claridad para los patrocinadores potenciales, por lo que no están tratando de adivinar cuánto deberían darte. Cada nivel de patrocinador tiene la opción de incluir una descripción.
- Sus objetivos (número de patrocinadores o cantidad objetivo): Los patrocinadores sienten curiosidad por su progreso y cómo pueden contribuir a que alcance su objetivo más rápido, por lo que es una buena práctica compartir sus objetivos en público junto con una razón para ese objetivo.
- Resalta las cuentas que te patrocinan: Para mostrar tu gratitud, resalta a las personas que te patrocinan. Esto también puede indicar que vale la pena apoyar su proyecto si otras personas lo patrocinan.
Después de crear tu perfil, configura un archivo funding.yml en la carpeta .github en la raíz del proyecto. Este archivo especial existe para que cuando las personas hagan clic en el botón sponsor (patrocinador), muestre una lista de opciones de financiamiento para su proyecto de código abierto. ¡Organizando tu perfil es el primer paso para hacer posible las carreras de código abierto!
Si estás interesado en patrocinar proyectos de los que dependes, puedes consultar la página de exploración de patrocinadores de GitHub. Esta lista incluirá una lista de proyectos de los que dependen sus cuentas e indicará cuáles son elegibles para el patrocinio.
tags: #cómo #ser #contribuyente #github