Aqui são introduzidos alguns conceitos e práticas recomendadas e/ou necessárias para manter a organização do projeto.
Perguntas recorrentes serão adicionadas como outros arquivos .MD
aka MarkDown neste repositório.
Isso pode vir a ser modificado, porém prosseguiremos assim até segunda ordem.
Teremos duas branches principais:
dev
release
Na branch dev, serão adicionadas periodicamente as modificações e funcionalidades aprovadas pelos líderes. Essa branch deve servir de espelho para a criação de outras branches.
Na branch release, serão adicionados todas as modificações presentes na dev após serem testadas. Nessa branch, estarão os lançamentos que serão enviados para os professores e gerência testarem. Somente os gerentes e quem for autorizado diretamente por eles poderá modificar essa branch de qualquer forma.
Toda funcionalidade que você estiver desenvolvendo deve estar centralizada em uma única branch dedicada a essa funcionalidade, seguindo o padrão feature/{funcionalidade}
. Por exemplo, digamos que você esteja trabalhando na funcionalidade de login, sua branch de trabalho deve se chamar feature/login
.
Toda correção em que você estiver trabalhando deve também estar centralizada em uma única branch. No caso o padrão é fix/{correção}
.
Code Review, em brasiliense, revisão de código, é uma prática importante para manter a qualidade do código e a padronização do projeto. Ela consiste na revisão do seu código por membros da equipe antes de ele ser mesclado com o progresso atual do projeto. Isso evita conflitos e garante um código mais homogêneo e menos falho.
Verifique o code-review no repositório.
O EditorConfig
é um projeto de plugin para padronização de formatação que é compatível através de múltiplos editores e IDEs.
Mais sobre o plugin EditorConfig
em netbeans-editorconfig
Tutorial de Git básico: aqui
Tutorial de Git e GitHub da RocketSeat: aqui
Git Kraken GUI pra quem não é fã do terminal ou prefere interface gráfica: aqui
Tutorial de Materialize: aqui