16 KiB
Introducción a GitHub
Esta lección cubre los conceptos básicos de GitHub, una plataforma para alojar y administrar cambios en su código.
Pre-lecture prueba
Introducción
En esta lección, cubriremos:
- seguimiento del trabajo que realiza en su máquina
- trabajar en proyectos con otros
- cómo contribuir al software de código abierto
Prerrequisitos
Antes de comenzar, deberá verificar si Git está instalado. En el tipo de terminal:
git --version
Si Git no está instalado, descargar Git. Luego, configure su perfil de Git local en la terminal:
git config --global user.name "tu-nombre"
git config --global user.email "tu-email"
Para comprobar si Git ya está configurado, puede escribir:
git config --list
También necesitará una cuenta de GitHub, un editor de código (como Visual Studio Code) y deberá abrir su terminal (o: símbolo del sistema).
Vaya a github.com y cree una cuenta si aún no lo ha hecho, o inicie sesión y complete su perfil.
✅ GitHub no es el único repositorio de código del mundo; hay otros, pero GitHub es el más conocido.
Preparación
Necesitará una carpeta con un proyecto de código en su máquina local (computadora portátil o PC) y un repositorio público en GitHub, que le servirá como ejemplo de cómo contribuir a los proyectos de otros.
Gestión de código
Digamos que tiene una carpeta localmente con algún proyecto de código y desea comenzar a rastrear su progreso usando git, el sistema de control de versiones. Algunas personas comparan el uso de git con escribir una carta de amor a su yo futuro. Al leer sus mensajes de confirmación días, semanas o meses después, podrá recordar por qué tomó una decisión o "revertir" un cambio, es decir, cuando escribe buenos "mensajes de confirmación".
Tarea: hacer un repositorio y enviar código
-
Crear repositorio en GitHub. En GitHub.com, en la pestaña de repositorios, o en la barra de navegación superior derecha, busque el botón nuevo repositorio.
- Dale un nombre a tu repositorio (carpeta)
- Seleccione crear repositorio.
-
Navegue a su carpeta de trabajo. En su terminal, cambie a la carpeta (también conocida como directorio) que desea comenzar a rastrear. Tipo:
cd [nombre de tu carpeta]
-
Inicializar un repositorio de git. En su tipo de proyecto:
git init
-
Comprobar estado. Para comprobar el estado de su tipo de repositorio:
git status
la salida puede verse así:
Changes not staged for commit: (use "git add <file>..." to update what will be committed) (use "git checkout -- <file>..." to discard changes in working directory) modified: file.txt modified: file2.txt
Por lo general, un comando
git status
le dice cosas como qué archivos están listos para ser guardados en el repositorio o tiene cambios que es posible que desee conservar. -
Agregar archivos al seguimiento
git add .
El argumento
git add
más.
indica que todos sus archivos y cambios para el seguimiento. -
Persistir en tu trabajo. En este punto, ha agregado los archivos a lo que se denomina área de preparación. Un lugar donde Git rastrea sus archivos. Para que el cambio sea permanente, debe commitir los archivos. Para hacerlo, crea un commit con el comando
git commit
. Un commit representa un punto de ahorro en el historial de su repositorio. Escriba lo siguiente para crear un commit:git commit -m "first commit"
Esto confirma todos sus archivos, agregando el mensaje "primer compromiso". Para futuros mensajes de confirmación, querrá ser más descriptivo en su descripción para transmitir qué tipo de cambio ha realizado.
-
Conecte su repositorio de Git local con GitHub. Un repositorio de Git es bueno en su máquina, pero en algún momento desea tener una copia de seguridad de sus archivos en algún lugar y también invitar a otras personas a trabajar con usted en su repositorio. Un gran lugar para hacerlo es GitHub. Recuerde que ya hemos creado un repositorio en GitHub, por lo que lo único que debemos hacer es conectar nuestro repositorio de Git local con GitHub. El comando
git remote add
hará precisamente eso. Escriba el siguiente comando:Tenga en cuenta que antes de escribir el comando, vaya a la página de su repositorio de GitHub para encontrar la URL del repositorio. Lo usará en el siguiente comando. Reemplaza
repository_name
con tu URL de GitHub.git remote add origin https://github.com/username/repository_name.git
Esto crea un remote, o conexión, llamado "origin" que apunta al repositorio de GitHub que creó anteriormente.
-
Envía archivos locales a GitHub. Hasta ahora ha creado una conexión entre el repositorio local y el repositorio de GitHub. Enviemos estos archivos a GitHub con el siguiente comando
git push
, así:git push -u origin main
Esto envía sus confirmaciones en su rama "principal" a GitHub.
-
Para agregar más cambios. Si desea continuar haciendo cambios y enviarlos a GitHub, solo necesitará usar los siguientes tres comandos:
git add . git commit -m "escribe tu mensaje de confirmación aquí" git push
Sugerencia: es posible que también desee adoptar un archivo
.gitignore
para evitar que los archivos que no desea rastrear aparezcan en GitHub, como el archivo de notas que almacena en la misma carpeta pero no tiene lugar para escribir su mensaje de confirmación aquí repositorio público. Puede encontrar plantillas para archivos.gitignore
en .gitignore templates.
Confirmar mensajes
Una gran línea de asunto de confirmación de Git completa la siguiente oración: Si se aplica, esta confirmación será <su línea de asunto aquí>
Para el sujeto use el imperativo, tiempo presente: "cambiar" no "cambiar" ni "cambiar". Como en el sujeto, en el cuerpo (opcional) también use el imperativo, presente. El cuerpo debe incluir la motivación para el cambio y contrastarla con la conducta anterior. Estás explicando el "por qué", no el "cómo".
✅ Tómate unos minutos para navegar por GitHub. ¿Puedes encontrar un mensaje de compromiso realmente bueno? ¿Puedes encontrar uno realmente mínimo? ¿Qué información crees que es la más importante y útil de transmitir en un mensaje de compromiso?
Tarea: Colaborar
La razón principal para poner cosas en GitHub fue hacer posible la colaboración con otros desarrolladores.
Trabajando en proyectos con otros
En su repositorio, vaya a Insights > Community
para ver cómo se compara su proyecto con los estándares comunitarios recomendados.
Aquí hay algunas cosas que pueden mejorar su repositorio de GitHub:
- Descripción. ¿Agregaste una descripción para tu proyecto?
- README. ¿Agregaste un archivo README? GitHub proporciona una guía para escribir un README.
- Pauta de contribución. ¿Su proyecto tiene pautas de contribución,
- Código de Conducta. un Código de conducta,
- Licencia. Quizás lo más importante, una licencia?
Todos estos recursos beneficiarán la incorporación de nuevos miembros del equipo. Y esos son típicamente el tipo de cosas que los nuevos colaboradores miran antes incluso de mirar su código, para descubrir si su proyecto es el lugar adecuado para que ellos pasen su tiempo.
✅ Los archivos README, aunque requieren tiempo para prepararse, a menudo son descuidados por los ocupados mantenedores. ¿Puede encontrar un ejemplo de uno particularmente descriptivo? Nota: hay algunas herramientas para ayudar a crear buenos archivos READMEs que le gustaría probar.
Tarea: Fusionar código
Los documentos que contribuyen ayudan a las personas a contribuir al proyecto. Explica qué tipos de contribuciones está buscando y cómo funciona el proceso. Los colaboradores deberán seguir una serie de pasos para poder contribuir a su repositorio en GitHub:
- Bifurcando su repositorio Probablemente querrá que la gente bifurque su proyecto. Bifurcar significa crear una réplica de su repositorio en su perfil de GitHub.
- Clonar. Desde allí, clonarán el proyecto en su máquina local.
- Crea una rama. Querrá pedirles que creen una _ rama_ para su trabajo.
- Concentre su cambio en un área. Pida a los colaboradores que concentren sus contribuciones en una cosa a la vez; de esa manera, las posibilidades de que pueda fusionar en su trabajo son mayores. Imagine que escriben una corrección de errores, agregan una nueva función y actualizan varias pruebas; ¿qué sucede si lo desea o solo puede implementar 2 de 3 o 1 de 3 cambios?
✅ Imagine una situación en la que las sucursales son particularmente críticas para escribir y enviar un buen código. ¿En qué casos de uso se te ocurren?
Tenga en cuenta que sea el cambio que desea ver en el mundo y cree también sucursales para su propio trabajo. Todas las confirmaciones que realice se realizarán en la sucursal en la que está actualmente "registrado". Use
git status
para ver qué rama es esa.
Repasemos el flujo de trabajo de un colaborador. Suponga que el colaborador ya ha bifurcado y clonado el repositorio para que tenga un repositorio de Git listo para trabajar en su máquina local:
-
Crea una rama. Use el comando
git branch
para crear una rama que contendrá los cambios que pretenden contribuir:git branch [branch-name]
-
Cambiar a rama de trabajo. Cambie a la rama especificada y actualice el directorio de trabajo con
git checkout
:git checkout [branch-name]
-
Trabaja. En este punto, desea agregar sus cambios. No olvide informarle a Git con los siguientes comandos:
git add . git commit -m "mis cambios"
Asegúrese de darle un buen nombre a su compromiso, por su bien y por el mantenedor del repositorio en el que está ayudando.
-
Combine su trabajo con la rama
principal
. En algún momento ha terminado de trabajar y desea combinar su trabajo con el de la ramaprincipal
. La ramamain
podría haber cambiado mientras tanto, así que asegúrese de actualizarla primero a la última con los siguientes comandos:git checkout main git pull
En este punto, querrá asegurarse de que cualquier conflicto, situaciones en las que Git no pueda combinarse fácilmente los cambios, ocurra en su rama de trabajo. Por lo tanto, ejecute los siguientes comandos:
git checkout [branch_name] git merge main
Esto traerá todos los cambios de
main
a su rama y es de esperar que pueda continuar. De lo contrario, VS Code le dirá dónde está confundido Git y simplemente modificará los archivos afectados para decir qué contenido es el más preciso. -
Envíe su trabajo a GitHub. Enviar tu trabajo a GitHub significa dos cosas. Empujar su sucursal a su repositorio y luego abrir un PR, Pull Request.
git push --set-upstream origin [branch-name]
El comando anterior crea la rama en su repositorio bifurcado.
-
Abra una PR. A continuación, desea abrir un PR. Para hacerlo, navegue al repositorio bifurcado en GitHub. Verá una indicación en GitHub donde le preguntará si desea crear un nuevo PR, haga clic en eso y lo llevará a una interfaz donde puede cambiar el título del mensaje de confirmación, asígnele una descripción más adecuada. Ahora, el mantenedor del repositorio que bifurcó verá este PR y dedos cruzados apreciarán y _ fusionar_ su PR. Ahora eres un colaborador, yay :)
-
Limpiar. Se considera una buena práctica limpiar después de ti. Desea limpiar tanto su sucursal local como la sucursal que envió a GitHub. Primero eliminémoslo localmente con el siguiente comando:
git branch -d [branch-name]
Asegúrese de ir a la página de GitHub para el repositorio bifurcado a continuación y elimine la rama remota que acaba de ingresar.
Solicitud de extracción
parece un término tonto porque realmente desea impulsar los cambios al proyecto. Pero el mantenedor (propietario del proyecto) o el equipo central debe considerar sus cambios antes de fusionarlo con la rama "principal" del proyecto, por lo que realmente está solicitando una decisión de cambio a un mantenedor.
Una solicitud de extracción es el lugar para comparar y discutir las diferencias introducidas en una rama con revisiones, comentarios, pruebas integradas y más. Una buena solicitud de extracción sigue aproximadamente las mismas reglas que un mensaje de confirmación. Puede agregar una referencia a un problema en el rastreador de problemas, cuando su trabajo, por ejemplo, soluciona un problema. Esto se hace usando un '#' seguido del número de su problema. Por ejemplo, #97
.
🤞 Cruce los dedos para que todos los controles pasen y los propietarios del proyecto combinen sus cambios en el proyecto🤞
Actualice su rama de trabajo local actual con todas las nuevas confirmaciones de la rama remota correspondiente en GitHub:
git pull
Cómo contribuir al código abierto
Primero, busquemos un repositorio (o: repositorio) en GitHub que le interese y al que le gustaría contribuir con un cambio. Querrá copiar el contenido de a nuestra máquina.
✅ Una buena forma de encontrar repositorios 'aptos para principiantes' es buscar por la etiqueta buena-primera-edición
.
Hay varias formas de copiar código. Una forma es "clonar" el contenido del repositorio, usando HTTPS, SSH o usando GitHub CLI (Interfaz de línea de comandos).
Abra su terminal y clone el repositorio así:
git clone https://github.com/ProjectURL
Para trabajar en el proyecto, cambie a la carpeta correcta:
cd ProjectURL
También puede abrir todo el proyecto utilizando Codespaces, el entorno de desarrollo en la nube / editor de código integrado de GitHub o GitHub Desktop.
Por último, puede descargar el código en una carpeta comprimida.
Algunas cosas más interesantes sobre GitHub
Puede destacar, ver y / o "fork" cualquier repositorio público en GitHub. Puede encontrar sus repositorios destacados en el menú desplegable de la parte superior derecha. Es como marcar como favorito, pero por código.
Los proyectos tienen un rastreador de problemas, principalmente en GitHub en la pestaña "Issues" a menos que se indique lo contrario, donde las personas debaten los problemas relacionados con el proyecto. Y la pestaña Solicitudes de extracción es donde las personas debaten y revisan los cambios que están en curso.
Los proyectos también pueden tener discusiones en foros, listas de correo o canales de chat como Slack, Discord o IRC.
✅ Eche un vistazo a su nuevo repositorio de GitHub y pruebe algunas cosas, como editar la configuración, agregar información a su repositorio y crear un proyecto (como un tablero Kanban). ¡Hay muchas cosas que puedes hacer!
🚀 Desafío: empareje con un amigo para trabajar en el código del otro. Cree un proyecto de forma colaborativa, bifurque el código, cree ramas y combine los cambios.
Post-lecture prueba
Revisión y autoestudio
Obtenga más información sobre contribución al software de código abierto.
Práctica práctica práctica. GitHub tiene excelentes rutas de aprendizaje disponibles a través de lab.github.com:
También encontrará laboratorios más avanzados.
Tarea: Completa la primera semana en el laboratorio de capacitación de GitHub