Cómo colaborar

OMSTD es un proyecto de carácter abierto y gratuito. Si te apetece compartir tu experiencia y conocimiento con otros, serás muy bienvenido.

Principalmente existen los siguientes tipos de colaboraciones:

• Corrección de errores y mejoras:.
• Propuestas de nuevos casos de estudios.
• Envío de un nuevo caso de estudio.
• Ayuda a la traducción.

Corrección de errores y mejoras

Si detectas cualquier fallo o algún punto mejorable puedes:

• Abrir un ticket o incidencia y será tratado con la mayor brevedad posible (Anexo 2).
• Enviar un parche que corrija dicho error (Anexo 1).

Propuestas de nuevos casos de estudios

Si deseas sugerir un nuevo caso de estudio, tan solo tienes que abrir un ticket con tu propuesta (Anexo 2).

Éste será clasificada y catalogada en función de la naturaleza del mismo.

Envío de un nuevo caso de estudio

El medio preferible para enviar nuevos casos de estudio es el siguiente:

• Crear un fork del proyecto (Anexo 3).
• Enviar un parche con el nuevo caso de estudio (Anexo 1).

De esta forma todo quedará registrado, para que todo el mundo pueda seguirlo, además de llevar un mejor orden.

Ayuda a la traducción

Este caso es muy parecido al anterior. pero con un cierto matiz:

• Crear un fork del proyecto (Anexo 3).
• Copiar la carpeta doc/es al directorio doc/LANG, donde LANG es el código ISO del lenguaje de la traducción. Por ejemplo: Si se está traduciendo a inglés sería doc/en. Sobre este directorio será sobre el que se trabajará y traducirá.
• Enviar un parche con el nuevo caso de estudio (Anexo 1).

Anexos

Anexo 1: Envío de parches usando GitHub

Una vez hemos forkeado y hechos los cambios pertinentes en el código, para enviar un parche siga las siguientes instrucciones:

1. Pulsamos en la opción de Pull Request:

2. Creamos un nueva nueva propuesta de parche pulsando en New pull request:

3. GitHub detectará los cambios realizados, extraídos de los commits que hayamos realizado, y preparará el request. Para finalizar el envío tan solo tenemos que pulsar en Create pull request:

Anexo 2: Apertura de incidencias en GitHub

La apertura de incidencias en GitHub es muy sencilla, tan solo tenemos que utilizar su sistema de ticketing:

1. Podemos ir directamente a los issues siguiendo el link https://github.com/cr0hn/OMSTD/issues, o podemos ir al home del proyecto, https://github.com/cr0hn/OMSTD, y pulsar en Issues, del menú de la derecha:

2. En esta pantalla nos aparecerán todas las incidencias y propuestas abiertas. Para crear una nueva pulsaremos en New Issue:

3. Para la apertura de la incidencia es necesario un título y una descripción. Es muy conveniente ser conciso en el título y explicar en detalle la incidencias, mejora o propuesta.

Anexo 3: Crear un fork de un proyecto en GitHub

Crear un fork de un proyecto en GitHub es realmente fácil. Tan solo tendrás que:

1. Identificarte con tu usuario,
2. Ir al repositorio oficial del proyecto: https://github.com/cr0hn/OMSTD
3. Hacer click en el botón superior derecho con el texto Fork. La siguiente imagen muestra cómo: