Contribuindo com artigos para o site
Sérgio Vilar
29/04/14

Olá pessoal, neste post irei explicar como vocês podem contribuir com o PHP-PB escrevendo artigos e submetendo via Github.

Se você ainda não tem uma conta no Github, pode se cadastrar aqui.

Fazendo fork do repositório

Para submeter algum artigo, antes, é necessário que você faça um fork no projeto original no github.

Abra o link do repositório e clique em fork:

Fork

Isso criará uma cópia do repositório original no seu perfil do Github.

Instalação do Git

Antes de tudo, precisamos instalar o git para clonar o nosso repositório.

Se você usa Mac OSX ou Windows, pode usar as versões para desktop do Github para os mesmos (aqui e aqui). Caso prefira usar a linha de comando, veja este tutorial do Github que dá instruções de como instalar o git no seu sistema operacional.

Feito isso, podemos clonar nosso repositório:

git clone git@github.com:<seu_username>/php-pb.github.io.git

Agora você terá uma cópia do projeto no seu computador.

Escrevendo o artigo

No PHP-PB usamos Jekyll para postarmos artigos, este que por sua vez exige que os posts sejam escritos usando a syntaxe markdown.

Para criar um novo post, crie um arquivo na pasta _posts seguindo a seguinte nomeclatura:

2014-04-13-sunshine-slides-favoritos.markdown


Todo arquivo de posts precisa ter um cabeçalho seguindo o exemplo a seguir:

---
layout: post
title: Contribuindo com artigos para o site
date: 2014-04-29 00:29:00
author: Sérgio Vilar
categories: 
- git
- tutorial
tags: 
- github
- contribuindo 
- conferência 
---


Com o artigo escrito, você pode visualizar o site rodando o Jekyll, mas para isso precisa antes instalar o Ruby na sua máquina e depois instalar as seguintes dependências:

gem install jekyll kramdown


Nota do autor: se não me engano, tanto o linux como o OSX já vêm com o ruby instalado

Com o Ruby e as dependências instaladas, você pode rodar o Jekyll:

jekyll serve


Ok, agora que temos nosso artigo pronto, vamos enviá-lo para o nosso repositório no github:

git add .
git commit -m "Adicionado o artigo <titulo_do_artigo>"
git push -u origin master    


Enviando a solicitação de publicação (Pull Request)

Para publicarmos nosso artigo precisamos submetê-lo ao repositório original do PHP-PB, no que consiste num merge das nossas modificações com o código do repositório original.

Pull Request

Agora criamos nosso Pull Request:

Pull Request 2

Descrevemos nossa solicitação e finalmente a enviamos:

Pull Request 3

E agora temos finalmente nossa Pull Request aberta aguardando que algum colaborador do repositório a aprove:

Issue

comments powered by Disqus