Skip to content

Guia de Contribuição

Robert San edited this page May 10, 2017 · 5 revisions

Observação

O site foi desenvolvido com Jekyll, logo então será necessário tê-lo instalado para poder contribuir e rodar a aplicação localmente.

Como contribuir

  • Dê um fork no repositório principal

  • Faça um clone do fork

    git clone https://github.com/valadoc-br/valadoc-br.github.io.git

  • Crie uma issue

    Para facilitar a rastreabilidade, crie uma issue com o nome do componente a ser criado ou modificado. Por exemplo, se o componente é um combobox então deve-se manter o nome dele sempre a frente na issue criada:

    ComboBox - inclusão de uma nova implementação

    A criação da issue serve para permitir que outros saibam qual componente você já está trabalhando, evitando assim varias pessoas desenvolvendo no mesmo componente.

  • Crie uma Branch:

    despois de ter criado sua issue crie um branch com:

    nome do componente(em minusculo) + "-" + o numero da issue

    Então seguindo esse padrão o nome do será branch deve fica assim combobox-1. Exemplo:

    git checkout -b combobox-1

  • Caso seja um novo componente basta criar um o arquivo com o nome(em minusculo) do componente na pasta componentes. Logo depois adicione o nome do componente e link no arquivo menu-lateral.html que está na pasta _includes.

    O codigo {{ site.url }} é responsável pela url base. Exemplo a inclusão do componente no menu deve ficar assim:

    <li><a href="{{ site.url }}/componentes/combobox">ComboBox</a></li>

  • Após finalização nos envie um pull request no repositório principal para avaliação

Clone this wiki locally