Contribuyendo a proyectos de código abierto utilizando GIT
¡Bienvenido a nuestro proyecto! Estamos emocionados de que esté considerando contribuir al desarrollo de código abierto. Esta guía lo guiará a través de los comandos Git esenciales y las mejores prácticas para que su contribución sea fácil y exitosa.
Tabla de contenido
- Bifurcando el repositorio
- Clonación del repositorio
- Creando una rama
- Haciendo cambios
- Cometer cambios
- Presionando cambios
- Creación de una solicitud de extracción
- Sincando tu tenedor
- Consejos para escribir buenos mensajes de confirmación
1. Bifurcando el repositorio
Antes de comenzar a contribuir, debe desembolsar el repositorio. FORKING crea una copia del repositorio en su propia cuenta GitHub.
Pasos:
- Navegue a la página del repositorio.
- Haga clic en el botón "Bifurca" en la esquina superior derecha.
- Ahora tendrá una copia del repositorio en su cuenta de GitHub.
2. Cloning the Repository
Después de bifurgar el repositorio, debe clonarlo a su máquina local para que pueda trabajar en ella.
git clone https://github.com/your-username/repository-name.git
3. Creación de una rama
Después de clonar el repositorio, cree una nueva rama para trabajar en sus cambios. Siempre trabaje en una rama separada para evitar conflictos con la rama principal:
git checkout -b feature/your-branch-name
4. Hacer cambios
Ahora que está en su rama, realice los cambios necesarios en el código, la documentación u otras partes del proyecto. Asegúrese de probar todo antes de pasar al siguiente paso.
5. Comprometer cambios
Una vez que sus cambios están completos, es hora de cometerlos. Sigue estos pasos:
- Agregue los cambios al área de puesta en escena:
- Confirme los cambios con un mensaje claro y descriptivo:
git commit -m " Your descriptive message here "
- Asegúrese de que su mensaje de confirmación explique claramente los cambios que realizó.
6. Empujar cambios
Después de cometer sus cambios localmente, empuje la rama a su repositorio de GitHub.
git push origin feature/your-branch-name
Esto cargará su rama a su repositorio bifurcado en GitHub.
7. Creación de una solicitud de extracción
Con sus cambios empujados a GitHub, está listo para enviar una solicitud de extracción (PR) para que los mantenedores puedan revisar su trabajo.
- Navegue a su repositorio bifurcado en GitHub.
- Haga clic en el botón "Comparar y extraer solicitud".
- Proporcione un título y una descripción detallada de sus cambios.
- Envíe la solicitud de extracción.
- Después de revisar, los mantenedores fusionarán su PR o proporcionarán comentarios para las revisiones.
8. Sincando tu bifurcación
Si el repositorio original se actualiza mientras trabaja, es posible que desee sincronizar su horquilla para mantenerlo actualizado. Aquí está como:
- Agregue el repositorio ascendente como control remoto:
git remote add upstream https://github.com/original-owner/repository-name.git
- Obtenga los últimos cambios del repositorio ascendente:
- Fusionar los cambios aguas arriba en su rama principal local:
git checkout main
git merge upstream/main
- Empuje la rama principal actualizada a su bifurcación:
9. Consejos para escribir buenos mensajes de confirmación
- Keep It Concise: apunte a un mensaje de confirmación que tenga menos de 50 caracteres.
- Use el estado de ánimo imperativo: por ejemplo, escriba "corrige el error" en lugar de "error fijo".
- Proporcione contexto: incluya el número de problema o describa el propósito del cambio.
Ejemplo: Solucione #42 - Resuelva el error en la autenticación del usuario.