Home

Histórico de versão

Data	Versão	Descrição	Autor(es)
28/11/2022	0.1	Criação do documento e remodelagem da estrutura da wiki	Pedro Helias Carlos
06/12/2022	0.2	Adicionando políticas de branches	Gabrielly Assunção

Houdini

Wiki responsável pela documentação das sprints dos grupos da matéria Gerência de Configuração e Evolução de Software, da UnB/FGA, referente ao projeto Houdini.

• Semestre 2022/1
• Semestre 2022/2

Padrões de issue, commit e branch

Para uma melhor organização do repositório é sugerido que a criação de issues em vista de possíveis problemas e melhorias, branchs e commits sigam os seguintes padrões:

Issue

Deve se iniciar a Issue com algumas questões que ajudam a direcionar o problema e propor soluções. Seguem a ordem das questões:

• Is your feature request related to a problem? Please describe;
• Describe the solution you'd like;
• Describe alternatives you've considered;
• Additional context.

Quanto ao título da Issue, temos primeiramente o tema principal a ser abordado, como BUG, FEATURE, entre outros, seguido do assunto a ser abordado e por fim uma tag que categorize a Issue.

Exemplo:

[FEATURE]Nonprofit events

Essa padronização não era definitiva, sendo considerada como modelo desde Fevereiro de 2020.

Branches

A divisão das branches tem o intuito de melhorar a dinâmica e a organização do fluxo de trabalho.

Feature

Essas são as branches na qual são desenvolvidos novos recursos ao projeto, elas serão criadas com o seguinte padrão: nome da tag + nome da branch camelCase.

Exemplo:

feature-branchName

Fix

São branches no qual são realizadas correções de bugs encontrados em ambiente de produção, serão criadas com o padrão: nome da tag + nome da branch em camelCase.

Exemplo:

fix-branchName

Commits

Já os commits não exigem uma padronização específica e detalhada, não fugindo do clássico commit bem feito, que acompanha a principal alteração e um breve comentário.

Exemplo:

Fix issue problem The problem was in...

Nota:

Vale lembrar que o idioma priorizado e utilizado pela comunidade, no geral, é o inglês. Portanto, convém utilizar o inglês para que toda a comunidade possa ter acesso ao que foi realizado e tomar parte da evolução do projeto.