Skip to content
This repository has been archived by the owner on Dec 6, 2019. It is now read-only.

Latest commit

 

History

History
57 lines (40 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

57 lines (40 loc) · 2.85 KB
Raw

Contribuindo

Você que chegou aqui com o objetivo de contribuir com este projeto, nós do PHP Santa Catarina agradecemos!

Testes de unidades, documentação, novas funcionalidades, sugestões... temos muitas áreas que com certeza você tem plenas possibilidades de nos ajudar! Aliás, você já conferiu nossa lista de tarefas?

Ferramentas básicas

Antes de explicarmos a estrutura básica do projeto é necessario conhecermos as ferramentas fundamentais que utilizamos para organizar o desenvolvimento.

git-flow

A partir deste post surgiu uma extensão para o git, o git-flow.

Esta ferramenta é extremamente útil para agilizar o desenvolvimento usando branchs.

Leia o post e instale a ferramenta para poder acompanhar as explicações que virão mais abaixo. Utilize também o cheatsheet do git-flow como material de auxílio.

Composer

O composer é uma ferramenta de gerenciamento de dependências de projetos PHP. Com ele é possível realizar a instalação de todas as bibliotecas que o software necessita utilizando um único comando.

Recomendamos também a leitura dos slides desta palestra do nosso amigo Rafael Dohms.

Code style

Todas as alterações DEVEM seguir a PSR-2.

Preparando o terreno

Você quer realizar alterações no código então? Muito bem, para começar a brincadeira você deve seguir os passos abaixo:

  1. Crie um fork e clone o projeto;
  2. Instale as dependências utilizando o composer (composer install);
  3. Defina as permissões de diretórios com o phing (vendor/bin/phing post-install);
  4. Aponte o branch local master para origin/master (git branch master origin/master);
  5. Inicialize o git-flow (git flow init -d);
  6. Crie seu branch
    • Caso seja uma nova funcionalidade você deve executar o comando git flow feature start $feature, onde $feature é um identificador para a funcionalidade a ser implementada;
    • Caso você opte por corrigir um bug você deverá inicializar um hotfix branch git flow hotfix start $hotfix, onde $hotfix deverá ser a versão atual, incrementando o número da última posição (PATCH).

Se tiver dúvidas a respeito do versionamento, leia esta especificação (ou sua versão original, em inglês).