# Contribuciones

Introducción
Existen dos maneras de contribuir: Simple y Avanzado
Haciendo un MR (Merge Request)
Cómo sugerir una característica o mejora.
Proceso de revisión de código

Tómese un momento para revisar este documento y hacer que el proceso de contribución sea fácil y efectivo para todos los involucrados.

# Introducción

¿Estás aquí porque quieres dar tu PLUS y mejorar nuestra documentación? ¡Excelente!, siéntase bienvenido y lea las siguientes secciones para saber cómo hacer preguntas y cómo trabajar en algo.

Se espera que todos los miembros de nuestro equipo sigan nuestro Código de Conducta. Asegúrese de ser amigable en todos nuestros espacios.

Hay muchas formas de contribuir, como: escribir tutoriales, mejorar la documentación, enviar solicitudes de funciones, o escribir código que pueda resolver un problema común.

Tenga en cuenta:

Tenemos un estilo de programación
Usamos Convención de Mensajes para los commits
Los archivos GIF deben tener menos de 2 MB de tamaño para que el service worker los almacene en caché
Debe usar Etiquetas (tags) para hacer referencia a palabras clave que no son titulos h1, h2 o h3. Estas palabras pueden ser h4, h5 o palabras claves que quieras que aparezcan en los resultados de búsquedas.
- en cada archivo .md tiene el siguiente aspecto, simplemente agregue tantos como sea necesario
- ```
    ---
    date: 2020-3-10 3:30:18 
    collaborators:
      - Roy Calderon
      - Neiro Méndez
    meta:
      - name: description
        content: Docs PLUSTEAM
      - name: keywords
        content: Tech, PLUS, TEAM
    tags:
      - Tag 1
      - Tag 2
      - Tag N
    ---
```
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15
  - Y cuando haya una coincidencia, lo notará porque solo aparece el título principal de la página que coincide. En este ejemplo, la página Contribuciones aparece en la página de resultados porque contiene una etiqueta llamadaTags
  - Los titulos h1, h2 y h3 tienen precedencia sobre palabras declaradas en la sección tags. No uses etiquetas para las mismas palabras que ya han aparecido en algún título h1, h2 o h3 del mismo archivo .md, puesto que estas no aparecerán en el resultado de búsqueda.

# Existen dos maneras de contribuir: Simple y Avanzado

# Editar directamente en GitLab (Simple)

# Usando el enlace "Help us improve here"

Encontrarás un enlace Help us improve here! al final de cada página. Este enlace te permitirá editar dicho archivo directamente en gitlab.

Haz cambios y después llena el mensaje de confirmación. Cuando hayas acabado, haz click en el botón "Commit changes". Recuerda que usamos convenciones para los mensajes de confirmación, por lo que debes estar seguro de seguir todas las reglas que allí se declaran.

Cuando termines de hacer los cambios, haz un "merge request"

Asigna el merge request (Assignee), añade etiquetas (Labels) y el Milestone correspondiente si este tiene. Después selecciona Delete source branch when merge request is accepted en Merge Options para borrar la rama fuente una vez haya sido aceptado el Merge Request.

Por último, haz click en el botón Submit merge request para finalizar la edición.

Si te gustaría aprender más sobre editar directamente en GitLab, dirígete aquí para obtener más información.

# Editar usando el IDE Web de GitLab

# Crea una nueva rama

Primero crea una nueva rama

Haz cambios y después haz click en el botón Commit. Si terminas de editar, haz click en la opción Start a new merge request.

Cambia a la rama que usaste para crear la rama actual, en este ejemplo develop

Por último, haz click en el boton Submit merge request para enviar el merge request y terminar la edición.

# Descargando nuestro repositorio (Avanzado)

Solo clona el proyecto del repositorio asegúrate de tener los requerimientos, y ejecútalo.

# Requerimientos

NodeJS
VuePress

# instalar globalmente
yarn global y vuepress
# OR
npm install -g vuepress

1
2
3
4

# Ejecutalo

Ve a la carpeta del proyecto y...

# corre el proyecto en modo desarrollo
vuepress dev

1
2

¡En este punto, estás listo para hacer cambios!

No dudes en pedir ayuda, todas somos principiantes al principio.

# Haciendo un MR (Merge Request)

Todos los cambios empiezan a partir de la rama de desarrollo. Tenemos una breve guía para ayudarte con eso.

# Cómo sugerir una característica o mejora.

Usamos Asana para esto. Puedes pedir acceso a nuestros fundadores e ingresar al workspace para dejar tus sugerencias en "+Docs - Backlog".

# Proceso de revisión de código

Tenemos una guía con Pautas para QA, donde mencionamos todo el proceso de revisión de código

← Home