Guia de Contribuição
Este guia tem como objetivo te ajudar a contribuir com o nosso projeto, por favor leia com atenção!
1. Antes de Começar
Os detalhes de como instalar e executar os projetos podem ser encontrados no README.md.
2. Reportando Bugs
Você encontrou um bug?
-
Sugestões de melhoria são rastreadas através de issues e pull requests no GitHub. Verifique se nenhuma issue ou pull request foi criada por outra pessoa com o mesmo bug.
-
Se não, crie uma issue explicando o problema e adicionando novas informações detalhadas que ajudem a reproduzi-lo.
3. Sugerindo Melhorias
Você pode sugerir as melhorias que achar pertinente. Pedimos apenas que tente incluir o máximo de detalhes possíveis e que verifique se nenhuma issue ou pull request já foi criado por outra pessoa com a mesma sugestão.
Caso seja algo novo, você tem duas alternativas:
- Criar uma nova issue.
- Compartilhar a sua sugestão com outros participantes e mantenedores do projeto.
Em ambos, tente usar uma linguagem clara e com o máximo de detalhes. Qual a motivação, qual problema resolveria e possíveis desafios, por exemplo, são importantes para entender o que você precisa. Esse é um projeto de código aberto, mantido por voluntários. Frequentemente precisamos escolher bem o que vamos fazer com os recursos que temos.
4. Criando Pull Requests
Você decidiu contribuir para o projeto!
Faça um fork do projeto e crie uma nova branch. Mais detalhes aqui.
Aqui algumas dicas:
-
Caso decida trabalhar em alguma issue, comente na issue escolhida. Dessa forma, outras pessoas saberão que tem alguém trabalhando nela. Caso tenha ficado perdido ou com dúvidas, peça ajuda.
-
Caso tenha visto algo pontual, como um typo ou algo que pode ser corrigido e testado rapidamente e não envolva mudanças estruturais, você é bem-vindo a abrir um novo PR também.
-
Antes de qualquer coisa, tente rodar o projeto localmente.
-
Rode os testes localmente. Além de ser uma boa prática, previne idas e vindas nas revisões.
-
Embora o código esteja escrito em inglês, por convenção, as mensagens de commit, comentários, pull requests, issues, e demais comunicações do projeto deverão ser escritas em português.
-
Marque a opção "Permitir edição pelos mantenedores". Assim poderemos fazer modificações de emergência mantendo o pull request aberto por você.
Nós possuimos também um template para o pull request que seguirá da seguinte forma:
Descrição - Criando e arrumando alguns docs
Revisão
- [x] mkdocs
- [x] Prototipo de alta
- [x] User Story Template
Pre-merge checklist
- [x] O Pull Request refere-se a um único assunto, um título claro e uma descrição em frases gramaticalmente corretas e completas.
- [x] A branch está atualizada com a branch main.
- [x] Os commits atendem o padrão especificado na política de contribuição.
5. Política de Branch
As branches serão nomeadas seguindo de maneira padronizada para a melhorar a organização do projeto. Utilizamos as branches apenas para desenvolvimento de código sendo que todas as branches devem ser criadas a partir da main e devem estar nomeadas da seguinte maneira:
X- Atividade
Exemplo:
4-GuiaDeContribuicao
Sendo que X representa número da issue atribuída seguido pelo nome do documento a ser criado ou modificado, como destacado anteriormente. Em ocasiões em que não se está trabalhando com nenhum documento em específico, então deve-se colocar o nome da issue correspondente.
6. Política de Commit
6.1 Formato:
Os commits devem ser feitos de maneira clara e objetiva respeitando os padrões comentados a seguir:
- Devem possuir um tipo, número da issue associada e o assunto.
- Devem ser escritas em português.
- Os verbos devem estar no gerúndio.
Portanto a formatação do commit será: <tipo>(#número da issue): assunto
:bulb:(#04): Desenvolvendo cadastro da impressora
Co-authored-by: julisous julia.farias2000@hotmail.com
6.1.1 Tipos:
- :bulb: quando adicionar nova funcionalidade
- :pencil: quando escrever documentação
- :repeat: quando alguma alteração for feita
- :racehorse: refatoração ou otimização
- :bug: quando consertar um bug
- :fire: quando remover código ou arquivos
Nas ocasiões em que o commit foi realizado por dupla ou grupo, deve ser acrescentado à mensagem do commit o seguinte texto:
Data | Descrição | Autore(es) |
---|---|---|
18/09/2023 | Criação do documento | Júlia Farias Sousa |
19/09/2023 | Correção gramatical e modificação da política de branch | Júlia Farias Sousa |
19/09/2023 | Revisão do documento | Lucas Lima Ferraz |
19/09/2023 | Recriando com usuário correto | Júlia Farias Sousa |
22/10/2023 | Arrumando bash e colocando o template de PR | Júlia Farias Sousa |
22/10/2023 | Revisão do documento | Antonio Rangel e Yuri Alves |