Como Contribuir

1. Orientações

• Se você for um colaborador externo, dê um fork no projeto.

• A criação de issues deve seguir a política de issues.

• A criação de branches deve seguir a política de branches.

• No desenvolvimento, usar nossa política de commits.

• Pull requests só serão aceitos se estiverem passando na integração.

2. Política de Branches deste repositorio.

Master

A master será nossa branch de produção, ou seja, nela estará a versão estável do projeto. E por questões de segurança ela será bloqueada para commits e push.A interação com a master vai se dá através da de Pull requests que virão das branch de documentos.

Branches de documentos

As branches de documentos são criadas a partir da master, e serve para criação ou refatoração de documentos seguindo a issue do mesmo. No final essa branch deve ser enviada para a master, através de um pull request.

Instalação

Instalando do google chrome

Página do Git Breakdown na Chrome Store

Rodando Localmente

É preciso ter algumas dependências para rodar a aplicação localmente.

Primeiro você precisa ter o Docker e o Docker-Compose instalado na sua máquina.

Rodando Add-on

Downloading

cd ~/your/directory/
git clone https://github.com/fga-eps-mds/2019.2-Git-Breakdown.git
cd 2019.2-2019.2-Git-Breakdown

Rode os seguintes comandos no terminal

sudo docker-compose build --no-cache
docker-compose up

Vá ate a configurações de extensões do chrome

e ative o Modo desenvolvedor

vá ate Carregar sem compacttação e adicione a pasta extension do diretório raíz do projeto.

A extensão estará fuincionando na aba do github.