Este tutorial de GitHub está amorosamente basado en el DjangoGirls How To Contribute Tutorial que está disponible bajo una licencia Creative Commons Attribution-ShareAlike 4.0.
Para este tutorial, utilizaremos el repositorio Maletín como base para los enlaces y referencias.
Introducción y requisitos previos
Para contribuir a BeeWare, se necesita lo siguiente para empezar:
- una cuenta de GitHub
- en el caso de ediciones complejas, familiaridad con Git command line Git o familiaridad con una aplicación (Windows y Mac) para empujar las ediciones realizadas en tu ordenador a GitHub.
Fork el repositorio
En primer lugar, bifurca el repositorio Maletín en tu cuenta personal de GitHub:
Edición de la documentación
Cambios simples
Para cambios sencillos, como correcciones de erratas, puede utilizar el editor en línea de GitHub de GitHub:
- Abra su página local de bifurcación en GitHub,
- ve al archivo README.rst en cualquier capítulo,
- pulsa el icono Editar (lápiz)
y puedes editar el capítulo directamente en github.com.
La sintaxis RST se utiliza para editar las páginas individuales de la documentación.
Nota
¡! La captura de pantalla anterior puede no reflejar lo que hay actualmente en el repositorio de GitHub. El repositorio cambiará de vez en cuando. Sin embargo, el proceso para enviar pull requests sigue siendo el mismo.
Guarde los cambios y cree una pull request como se explica a continuación.
Código nuevo y cambios complejos
Para añadir código nuevo, ampliar clases o realizar cambios complejos, es necesario obtener una copia del código en tu ordenador local.
Utiliza la aplicación de GitHub para tu sistema operativo (mencionada anteriormente) o la línea de comandos para obtener el repositorio localmente. La dirección del repositorio de la página principal de tu propio repositorio GitHub:
git clone git@github.com:yourusername/briefcase.git
A continuación, crea una rama en la que se asienten tus nuevos cambios. Ayuda a llamar la rama algo relacionado con los cambios que va a hacer.
git checkout -b actualizar_documentacion
Haga cualquier cambio en el código, y asegúrese de que se prueban, y se guardan localmente.
A continuación, confirma los cambios con git y envíalos a tu repositorio remoto de
GitHub remoto.
Ejemplo:
$ git status
En la rama update_documentation
Archivos sin seguimiento:
(use "git add <archivo>..." para incluirlos en lo que se confirmará)
README.rst
git add README.rst
$ git commit -m "Actualizar la documentación README.rst para Briefcase"
[update_documentation fe36152] Añadida captura de pantalla de gitbook
1 archivo cambiado, 0 inserciones(+), 0 eliminaciones(-)
crear modo 100644 README.rst
$ git push
Contando objetos: 11, hecho.
Compresión delta usando hasta 8 hilos.
Comprimiendo objetos: 100% (5/5), hecho.
Escribiendo objetos: 100% (5/5), 266.37 KiB | 0 bytes/s, hecho.
Total 5 (delta 1), reutilizados 0 (delta 0)
En git@github.com:yourusername/briefcase.git
b37ca59..fe36152 actualizar_documentacion -> actualizar_documentacion
Hacer un pull request
Después de haber terminado sus cambios que usted necesita para crear un pull request en GitHub. BeeWare será notificado acerca de la solicitud de extracción, revisar su cambios, sugerir correcciones si es necesario y luego pull sus cambios a la versión principal.
En tu propio repositorio en GitHub pulsa Compare & pull request.
Rellene la información por qué se realiza este cambio. El revisor puede ver los detalles del cambio real, por lo que no es necesario repetir el contenido del cambio.
A continuación, pulse Crear pull request.
Los correos electrónicos de GitHub te notificarán el proceso de seguimiento.