¿Cómo contribuir?

Codea utiliza Gatsby, el cual es un generador de sitios web estáticos.

Ahora bien, existen dos formas de contribuir:

  • Creando contenido
  • Agregando nuevas secciones al sitio web

Sugerimos empezar compartiendo tus experiencias en el mundo de la computatión.

Crea tu primer artículo

Idea

¿Qué deseas compartir?

Fork

Crea un fork del repositorio de Codea

Plantilla

Puedes revisar la plantilla que está en docs/markdown/plantilla/

Escribir artículo

En un archivo llamado index.md dentro de docs/markdown/[fecha]-[nombre-del-articulo]/

Pull requests

Crea un PR (Pull requests) en GitHub y espera a que sea aceptado

Comentarios

Sugerencias por parte de la comunidad

:)

¿Qué es un repositorio?

Git utiliza los repositorios para mantener el control de las versiones de de los archivos que son parte de un proyecto.

Está en nuestros planes escribir una guía más detallada del uso de Git, pero por el momento podemos decirte que es un tipo de índice que dice quién ha hecho cambios y qué cambios hizo. Es una forma de permitir proyectos colaborativos y evitar, o reducir problemas de colisión y alteración simultánea de contenido.

Creemos que los siguientes temas son básicos para empezar a colaborar:

  • Mostrando tus repositorios remotos
  • Añadiendo repositorios remotos
  • Recibiendo de tus repositorios remotos
  • Enviando a tus repositorios remotos
  • Inspeccionando un repositorio remoto
  • Eliminando y renombrando repositorios remotos

¿Qué es un Pull Request?

En Git se parte de que el repositorio existe en local, tu computadora, y en remoto, un servidor.

Y se usa una terminología común para referirse a la transferencia entre los dos entornos.

Hacer pull es obtener una versión remota, y hacer push es enviar la versión local, el repositorio que se encuentra en GitHub es manejado por nosotros y está ligado a la versión en línea del sitio. Aunque confiemos en la gente, es peligroso que cualquiera pueda actualizar el contenido y modificar el sitio sin una validación por parte del equipo.

¿Qué es un branch?

Muchos desarrolladores pueden trabajar en distintas partes del código al mismo tiempo, las branches son versiones diferentes del código pero que están interconectadas al pensar que temporalmente pertenecen todas a un árbol y se van dividiendo como las ramas que parten de un único tronco, de ahí su nombre.

¿Cómo escribir un artículo?

Eres libre de elegir el tema que quieras, aquí sólo hablaremos respecto a la parte técnica. Los artículos se encuentran en el directorio docs/markdown/ a partir de la raíz de nuestro repositorio, es necesario crear un nuevo directorio con la fecha y el nombre del archivo, sin espacios o caracteres especiales y separado por guiones. Dentro de este directorio crear un archivo llamado index.md. En este último es donde podrás escribir el contenido de tu artículo.

Estamos trabajando en guías más detalladas, pero por el momento te recomendamos ver los artículos que ya existen.

¿Qué otros detalles son importantes?

En author.yaml tienes que agregar tu información si es la primera vez que escribes, en docs/authors/avatars/puedes subir una imagen para que aparezca en tu perfil y en src/data/tags.yaml es necesario agregar los tags si es la primera vez que los usas y no aún existen.