Contribuir
La idea es que todos los que formamos Platanus podamos participar en la evolución constante de esta guía. Para hacerlo de forma ordenada y que sea útil sigue estos lineamientos:

1. Identifica a qué sección de la guía corresponde lo que quieres agregar.

Las secciones son:
Por ejemplo: si te volviste experto en el manejo de sidekiq (herramienta que usamos para el procesamiento en background) deberías agregar este conocimiento a Stack/Ruby

2. Si lo que agregas es solo un link, agrégalo directamente en la sección que corresponda.

Siguendo con el ejemplo, en Stack/Ruby deberías agregar:
* [Sidekiq](https://github.com/mperham/sidekiq): lo utilizamos para procesamiento en background.

3. Si lo que agregas es más que un link, crea una sección nueva.

Siguendo con el ejemplo, deberías crear dentro del directorio /stack/ruby un archivo /sidekiq.md y apuntarlo desde Stack/Ruby así:
* [Sidekiq](sidekiq.md)
y dentro de sidekiq.md deberías tener algo como:
1
# Sidekiq
2
3
En Platanus utilizamos [sidekiq](https://github.com/mperham/sidekiq) para procesamiento en background.
4
5
### Contenido extra 1
6
7
bla bla
8
9
### Contenido extra 2
10
11
ble ble
Copied!

4. Si lo que agregas es demasiado grande para mantenerlo en una única sección, utiliza directorios.

Siguendo con el ejemplo, deberías tener en Stack/Ruby un directorio sidekiq con un archivo README.md y apuntarlo así:
* [Sidekiq](sidekiq/README.md)
Es importante que en archivo se llame README.md para que github lo levante automáticamente al entrar a la carpeta.
Luego deberías agregar cada sección dentro del directorio /sidekiq y apuntarlas en sidekiq/README.md así:
1
# Sidekiq
2
3
* [Contenido extra 1](extra1.md)
4
* [Contenido extra 2](extra2.md)
Copied!
y por último, las secciones quedarían así:
1
### Contenido extra 1
2
3
bla bla
Copied!
y
1
### Contenido extra 2
2
3
ble ble
Copied!

5. Respeta el tamaño de los títulos.

    ## Título
    ### Subtítulo
    #### Sub Subtítulo

6. Asegúrate que el contenido a agregar sea valioso.

En general deberías:
    Agregar links a herramientas que utilizamos en Platanus.
    Evitar copy/paste de READMEs de librerias y gemas. Con el link basta.
    Evitar agregar conentido fácilmente deprecable.
    Agregar contenido extra cuando este explique alguna manera particular de usar una herramienta en Platanus. Por ejemplo, si configuramos algo específico de sidekiq en nuestros proyectos, quizás valga la pena mencionarlo pero si es algo que sale en el README de la gema, mejor no hacerlo.
    Siempre que sea posible, escribir en el blog antes que en la guía y luego hacer el link al post.

7. Recuerda agregar los links a summary

Es necesario colocar en summary referencias al contenido ya que a partir de este archivo, se generará la guía aquí
Última actualización 1d ago