Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (25 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

36 lines (25 loc) · 2.6 KB

Pasos para contribuir

  1. Tener una cuenta en GitHub.com
  2. Descarga el software https://desktop.github.com/ para gestionar tus repositorios en local.
  3. Ingresa al repositorio de interés, ejemplo: https://github.com/victorhtorres/Java
  4. Clic en la opción Fork. Esto crea una copia del repositorio en tu cuenta de GitHub.
  5. Clona el repositorio en tu equipo local, por medio del software recomendado en el paso 2.
  6. Realiza los cambios que deseas hacer en el repositorio desde tu equipo local.
  7. Abre el software descargado en el paso 2 y comenta los archivos que fueron modificados. Este paso se le llama commit.
  8. En el software, clic en Sync para actualizar tu repositorio en github.com. Este paso también se le conoce como push.
  9. Ve a tu repositorio en github.com y crea un Pull request. Esto generará una discusión y aviso al desarrollador del repositorio original, con el fin de que acepte los cambios que realizaste en el repositorio.
  10. Si los cambios son aceptados, recibirás una notificación de que el repositorio original fue actualizado ( Merged ) y tu contribución fue exitosa.

Importante

Asegúrate de mantener siempre actualizado tu repositorio clonado con el original. En el software descargado, hay una opción llamada Update from victorhtorres/master, das clic en el y actualizará el repositorio local y luego clic en Sync, para actualizar tu repositorio en github.com.

Otros aspectos a tener en cuenta

  • Los cambios en tus repositorios lo puedes hacer desde la página de github.com, pero siempre es recomendable trabajar en local.
  • El repositorio de java tiene una carpeta llamada images. En ella, se guardan todas las imágenes que se van a usar en la documentación.
  • La documentación está escrita en un lenguaje de marcado llamado Markdown. Este lenguaje es más sencillo que el HTML y se ha creado un repositorio exclusivo para explicar la sintaxis básica: Repositorio sobre Markdown.
  • Para tener una guía de como insertar una imágen, enlace, etc... Entonces es más sencillo ver el código fuente del archivo README.md y ver como se hizó en algunas partes de la documentación.
  • Aprende más sobre el flujo de trabajo en github: https://guides.github.com/introduction/flow/
  • Aprende más sobre el sistema de control de versiones git: https://git-scm.com/book/en/v2

El objetivo de este repositorio

  1. Tener una rápida referencia sobre los temas más utilizados en Java.
  2. Aprender.
  3. Recordar.

El beneficio es para todos. Ayudanos a difundir y mejorar este repositorio.