Skip to content

Latest commit

 

History

History
236 lines (163 loc) · 7.91 KB

CONTRIBUTING.md

File metadata and controls

236 lines (163 loc) · 7.91 KB
Raw

Tabla de contenido

1. ¿Cómo contribuir?

2. Guías para colaborar

¿Cómo contribuir?

Hola👋 a todos.
Las contribuciones a este repositorio son bienvenidas. Si deseas mejorar esta hoja de referencia o traducirla a otros idiomas, ¡considera abrir un nuevo issue! y lo trataremos juntos.

Si quieres contribuir debes leer y aceptar nuestro Código de Conducta

Guías para colaborar

A continuación se detallan los pasos a seguir para configurar el repositorio y levantar el ambiente de desarrollo.

Trabajar en un Issue

IMPORTANTE: antes de trabajar en un PR, elija un issue y discuta los cambios previstos con los mantenedores. Pueden proporcionar información invaluable y orientarlo en la dirección correcta para aprovechar al máximo su contribución.

Ramas

master es la rama principal sobre la que nos desarrollamos y usaremos para desplegar el sitio. Todas las ramas de issues deben estar ramificadas directamente desde la rama master es importante crear una nueva rama sobre la que se trabajara antes de empezar a realizar cualquier cambio.

Workflow

🌐 GitHub

  • Si te gusta la comunidad antes nos regalas una ⭐ al repositorio, te lo agradecemos.
  • Accede al repositorio del proyecto web y realiza un fork

    Un Fork es hacer una copia del repositorio y a partir de esta copia hacer cambios. El Fork esta en la parte superior derecha de la pagina.

  • Copiar la URL del repositorio copiado (forked)
  • Elegir un issue en el cual trabajar. Si nadie esta trabajando en el, comenta que tomas el issue para que te sea asignado.

📄 Pre-requisitos

👷 Configuración local

  • Abrir una terminal, navegar al directorio en el que se creará el proyecto y clonar el repositorio fork. git clone https://github.com/[usuario-github]/web.git

    Para igualar los cambios del repositorio original Ver aquí

  • Crea una nueva rama cuyo nombre describa el issue en el que se va a trabajar, por ejemplo arregla-issue-1. 
    git checkout -b tarea-issue-1

🔨 Levantar ambiente de desarrollo

  • Instalar GatsbyJS

    npm install -g gatsby-cli

  • Instalar dependencias

    npm install

  • Ejecutar el proyecto de forma local

    gatsby develop

  • Hacer los cambios necesarios. Se puede visualizarlos con status

    git status

⬆️ Enviar cambios (commits)

Para este proyecto usaremos Commit Lint que usa Conventional Commits, esto nos proporcionará un estándar al momento de escribir un commit e identificar el propósito del mismo.

  • Realizar un commit usando las siguientes líneas

    git add archivos-creados-o-editados
git commit -m "docs(README): Agregada sección de colaboradores"

    Al final del documento se encuentra una guía detallada de Conventional Commits

  • Una vez hecho el commit, subir la rama (branch) creada al fork.

    git push -u origin tarea-issue-1

🚀 Pull Request

  • Dirigirse al repositorio principal en GitHub
  • Se presenta un mensaje sugiriendo crear un pull request.
  • Verificar que la rama base a la izquierda sea master o main y la rama a comparar a la derecha sea la creada (tarea-issue-1 en este ejemplo).
  • Reemplazar el texto del template indicando los cambios realizados y el issue que resuelve, en este caso de ejemplo close #1.

💪 Segundo Pull Request

NOTA: Asegúrate de repetir este proceso antes de tomar una nuevo issue.

  • Antes de tomar un nuevo issue o hacer un Pull Request debe seguir estos pasos para igualar tu Fork con los ultimos cambios del repositorio.

  • Debes cambiarte a la rama master

 git checkout master
  • Para comprobar que estas en la rama master ejecutar
 git branch

Asegurarse de no tener cambios pendientes, esto lo puedes ver haciendo git status, en caso de tenerlos hacer commit de los cambios Guia commit

  • Debemos conectar el repositorio local con el repositorio remoto principal
    git remote add upstream https://github.com/javascriptecuador/web.git
  • Para comprobar que se conectó al repositorio principal
 git remote -v
  • Traemos los ultimos cambios remotos a nuetro repositorio local
 git pull upstream master
  • Subir los cambios al Fork
 git push origin master

Recuerda cambiarte a la rama issue que creaste

 git checkout nombre-branch
  • Ahora puedes seguir los pasos para enviar tus cambios

Guía Conventional Commits

A continuación tenemos una estructura completa de un Conventional Commit:

[tipo]([ámbito opcional]): [descripción]

[cuerpo opcional]

[nota de pie opcional]

Aquí tenemos una estructura con solo los campos obligatorios:

[tipo]: [descripción]

Ejemplos:

feat(home): añadir pie alternativo al home

Implementar una versión alternativa del pie de página
Agregar iconos alternativos en la versión móvil del pie de página

Soluciona la incidencia #3

feat: cambiar títulos y estilos en la página de inicio

Explicación de los campos

Tipo (obligatorio) Los principales tipos de commits son

  • fix: corrige un error
  • feat introduce nuevas funcionalidades
  • docs completa la documentación del proyecto

Se permiten otros tipos de commit pero se recomienda los que usan Angular Convention

Ámbito (opcional) Se puede agregar un ámbito al tipo de commit para proveer información contextual adicional. Es opcional y se escribe entre paréntesis. Ejemplo:

feat(parser): añadir capacidad de parsear arrays

Descripción (obligatoria) Es obligatoria una descripción corta de los cambios realizados en el código.

Cuerpo (opcional) Puede agregarse después de la descripción, dando información adicional acerca de los cambios en el código. Debe iniciar con una línea en blanco después de la descripción.

Nota de pie (opcional) Puede agregarse tras una línea en blanco después del cuerpo o después de la descripción en caso de que no haya un cuerpo. Debe contener referencias adicionales a los números de problemas registrados sobre el cambio del código (ejemplo corrige incidencia #154).