- Para contribuir no projeto é recomendado abrir as issues existentes e o backlog do produto em SysArq Docs para entender o que o projeto precisa atualmente.
- Se você perceber que o seu problema ainda não foi documentado crie uma issue, porém priorize as já existentes.
- Se você for um colaborador externo, dê um fork no projeto.
- Issues só poderão ser criadas com os templates de issue especificados no repositório.
- 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 com o template de pull request especificado no repositório.
Nossa política segue algumas características do Gitflow. Então separamos nossas branches em:
A main 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 main vai se dá através da de Pull requests que virão da branch devel.
A devel será nossa branch de desenvolvimento, ou seja, vai agrupar o trabalho vindo das branches de features, o objetivo é criar uma release que será submetida para main.
As branches de features são criadas a partir da devel, e serve para o desenvolvimento de features presentes nas issues do repositório. No final do desenvolvimento a funcionalidade desenvolvida nessa branch deve ser enviada para a devel, através de um pull request.
Nomenclatura das branches de features:
O nome das branches de features devem seguir um padrão X_Nome_da_issue , onde X é o número da issue correspondente a funcionalidade.
Hotfix branches são criadas a partir da main e servem para resolver de forma rápida os bugs em produção. Essa branch deve seguir a seguinte nomenclatura: hotfix_Nome_do_bug.
Os commits devem descrever de forma simples e sucinta as modificações feitas. E devem ser escritas em português. Exemplo:
git commit -m ”Cria nova model”
Quando se está usando a técnica de pair programming deve-se deixar especificado todos os autores envolvidos no desenvolvimento da funcionalidade. Por isso é necessário utilizar a tag co-authored-by do Github, a seguir um passo a passo:
1 - Após usar o comando git add para adicionar as mudanças feitas, execute o seguinte comando:
git commit
2 - Abrirá um editor de texto mostrando algumas configurações do que foi feito. Na primeira linha digite a mensagem do commit e depois pule duas linhas e adiciona a co-autoria como no exemplo abaixo:
Add new routers
Co-authored-by: Paulo Vitor <paulovitorrocha.unb@gmail.com>
Co-authored-by: Joao Rossi <bielrossiborba@gmail.com>
Depois disso salve e o commit será contabilizado pelo Github.
Obs: Não exclua nada, apenas acrescente o que foi dito acima.