Caso queira contribuir com o projeto, talvez seja uma boa ideia começar pelo README para conhecer melhor sobre nós. Outro documento importante e que deve ser lido é o Código de Conduta.
Obrigado por contribuir! 🎉👍 Sua ajuda será recebida com muita gratidão!
-
Esse projeto segue um padrão de Issues. Logo, caso encontre um bug, verifique se ele não se encontra em uma das nossas Issues. Os bugs devem ser marcados com tag (label) bug.
-
Se o bug encontrado não consta nas Isses, basta abrir uma Nova Issue.
-
Primeiro verifique que não existe nenhuma Issue a respeito dessa modificação e/ou adição.
-
Caso não exista, crie uma Nova Issue. Dê um título significativo a ela, coloque uma descrição e pelo menos uma label.
-
As mudanças devem ser submetidas através de Pull Requests. Você pode encontrar mais sobre isso no Pull Requests Template.
-
Os commits devem ser todos em inglês;
-
Ele deve conter um título curto e objetivo do que foi feito naquele commit;
-
Após esse título, deve-se descrever, com um pouco mais de detalhes, todas as atividades executadas.
-
Caso esteja trabalhando em com algum associado assine nos seus commits os seus parceiros
Exemplo:
Creating project community files (Título curto e objetivo)
Adds project license (Descrição de uma das atividades)
Adds project code of conduct file
Adds project contributing file
Adds project issue template file
Adds projects pull request file
Co-authored-by: Mariana Mendes <mare.s.mendes@gmail.com> (Assinatura de parceria)
Tendo como meta manter a integralidade e confiabilidade do código do projeto foi proposta a utilização de política de branches. Essa Política de Branches deverá guiar os desenvolvedores na forma de organização de suas contribuições ao repositório. OBS: A política de branchs foi idealizada para trabalhar em conjunto com a ferramenta do git flow, sua documentação e mais informações podem ser acessadas aqui.
-
master - Branch principal do repositório onde será permitida somente a integração de software consolidado e testado. Essa branch será exclusiva para a entrega de Realeases, ou seja, um conjunto maior de funcionalidades que integram o software, aqui estará a versão stable do software.
-
develop - Branch para integração de novas funcionalidades, onde será permitido a entrega das features desenvolvidas e que estão em um estágio avançado de completude. Será o branch base para o início do desenvolvimento das features e da correção de bugs. Aqui também serão mergeadas as releases.
-
feature/ - Branch utilizada para o desenvolvimento de novas features do backlog. Caso a feature tenha sida proposta por uma issue do repositório e aceita no backlog o nome deverá conter o número da issue. Ex: feature/1- (Considerando que a feature tenha sido solicitada na issue #1)
-
bugfix/ - Branch utilizada para corrigir bugs de baixa/média urgência e que não estão presentes na branch master. Caso o bug tenha sido reportado por uma issue do repositório o nome deverá conter o número da issue. Ex: bugfix/1-<descrição-do-bug> (Considerando que o bug tenha sido reportado na issue #1)
-
hotfix/ - Branch utilizada para corrigir bugs de alta urgência e que estão presentes na branch master. Caso o bug tenha sido reportado por uma issue do repositório o nome deverá conter o número da issue. Ex: bugfix/1-<descrição-do-bug> (Considerando que o bug tenha sido reportado na issue #1)
-
release/<versão-da-release> - Branch onde será feito os ajustes finais/build antes da entrega de uma versão do produto de software. Constará no nome da branch a versão da release a ser entregue.
-
support/ - Branch onde serão executadas tarefas de suporte relacionadas ao software, como elaboração de documentações, correções de natureza de gerência de configuração e etc.