Histórico de Revisão

Data	Versão	Descrição	Autor(es)
06/09/2019	0.1	Criação do Documento	Byron Kamal

1. Introdução

O presente documento tem como finalidade orientar a todos que buscam contribuir com o repositório, apresentando padrões, políticas, ferramentas, instruindo sobre o ambiente de desenvolvimento e qualquer atividade de configuração necessária.

2. Políticas

2.1 Política de Commits

Commits atômicos

Sempre divida seu trabalho em commits pequenos e significativos de forma que cada commit implemente somente uma funcionalidade.

Adota-se para este projeto padrões para o comentário e execução dos commits. O idioma padrão para efetuar commits neste repositório é o inglês. As mensagens devem ser suscintas e expressarem de forma clara e objetiva a ação do commit.

Regra 50/72

As mensagens devem ser escritas em 50 caracteres, caso seja necessário escrever uma mensagem maior, escreva um resumo em 50 caracteres, adicione um linha em branco, e descreva melhor o commit em quantas linhas desejar, porém todas as linhas devem ter no máximo 72 caracteres. Caso não consiga descrever o seu commit com essa regra, o seu commit provavelmente não é atômico.

Commit

A anatomia do commit deve seguir o seguinte padrão:

Formato:

assunto

<corpo>

Assunto

Máximo de 50 caracteres
Tipo de escopo devem estar em letras minúsculas

Exemplo:

Add Sprint document.

2.2 Política de Branches

Para garantir um fluxo de trabalho contínuo e de forma padronizada possibilitando o rastreamento das funcionalidades desenvolvidas e facilitando a implementação de pipelines de integração(CI) e entrega(CD) contínua, será utilizada a estratégia de Git Flow.

Os conceitos chave para implementação da estratégia de Git Flow:

master: contém o nosso código de produção, todo o código que estamos desenvolvendo, em algum momento será “juntado” com essa branch
develop: contém o código do nosso próximo deploy, isso significa que conforme as features vão sendo finalizadas elas vão sendo juntadas nessa branch para posteriormente passarem por mais uma etapa antes de ser juntada com a master
feature/*: são branches para o desenvolvimento de uma funcionalidade específica, por convenção elas tem o nome iniciado por feature/, por exemplo: feature/cadastro-usuarios. - - Importante ressaltar que essas branches são criadas sempre à partir da branch develop
hotfix/*: são branches responsáveis pela realização de alguma correção crítica encontrada em produção e por isso são criadas à partir da master. Importante ressaltar que essa branch deve ser juntada tanto com a master quanto com a develop
release/*: tem uma confiança maior que a branch develop e que se encontra em nível de preparação para ser juntada com a master e com a develop (caso alguma coisa tenha sido modificada na branch em questão)

Exemplo do fluxo de branches:

Nomenclatura

Toda branch criada deve estar relacionada a uma funcionalidade ou correção, logo necessariamente deverá estar atrelada a uma Issue. O nome da branch deve ser em INGLÊS e deve seguir o padrão:

feature/IssueID-USX#nome-da-issue: para Historias de Usuário;
feature/IssueID-descrição-curta: para funcionalidades que não são Historias de Usuário.
hotfix/IssueID-descrição-curta: para correções;

3. Uso de Issues

As issues serão criadas com o objetivo de mapear e descrever todo o trabalho a ser desenvolvido durante o projeto, possibilitando controle e transparência do que está sendo feito. Com isso, conseguiremos manter o rastro de tudo que foi planejado e efetuado.

As issues vão conter identificadores e labels, para que se possa indicar sua natureza. Um template de issue pode ser encotrada aqui.

4. Ferramentas

Ferramenta	Descrição
Git	Ferramenta de versionamento
GitHub	Ferramenta de hospedagem de repositórios e controle de versão
ZenHub	Ferramenta de gerenciamento de equipe
React JS	Framework para a criação do Web App
Node	Tecnologia para criação de API's
Docker	Ferramenta de virtualização e configuração de ambiente por meio de containers
Docker Compose	Ferramenta de gerenciamento de containers Docker
Travis CI	Ferramenta de integração contínua
Heroku	Ferramenta para o deploy
CodeCov	Ferramenta de análise de cobertura de testes
VS Code	Ferramenta de construção e edição de código fonte

5. Referências

PMI. Um guia do conhecimento em gerenciamento de projetos. Guia PMBOK® 5a. ed. - EUA: Project Management Institute, 2013

Semantic Versioning 2.0.0 . Semantic Versioning Specification (SemVer). Disponível em <http://semver.org/>

PlataformaJogosUnB. Plano de Gerenciamento de Configuração de Software. Disponível em <https://github.com/fga-gpp-mds/2017.1-PlataformaJogosUnB/wiki/Plano-de-Gerenciamento-de-Configura%C3%A7%C3%A3o-de-Software>

Gymnasteg

Plano de Gestão e Configuração de Software