Instruções para contribuir com um tutorial
Traduzido por Maujor, site do Maujor
O site de tutoriais usa a tecnologia jekyll para renderizar suas páginas e todos os documentos do site são escritos com uso da sintaxe markdown. Para contribuir com um ou mais ( ;-) ) tutoriais siga os seguinte passos:
- Dê um fork no repositório do github clicando no botão “Fork”.
- Execute o comando
git clone
no seu fork. - Crie um arquivo denominado
YYYY-MM-DD-nome_do_tutorial.markdown
e salve no diretório_posts
do seu fork. -
No início do arquivo recém criado use a sintaxe YAML para serializar alguns dados que são padronizados para os tutoriais. Veja um exemplo destes dados que se aplica a este documento que você está visualizando:
--- layout: default title: Contribua com um tutorial permalink: contributing ---
- A seguir escreva seu tutorial usando a sintaxe markdown.
- Commit seu tutorial para o seu repositório.
- Feito o commit envie-o para seu fork.
- Finalmente abra um pull request e nele acrescente uma breve descrição do seu tutorial. Feito!
Você pode tomar como base para seu tutorial a estrutura do tutorial Rails Girls App Tutorial.
Nossos mais efusivos agradecimentos por dedicar seu tempo em favor do enriquecimento dos conteúdos do site Rails Girls.