Este guia explica como contribuir de forma rápida e consistente.
-
Crie uma Issue:
No GitHub, vá emIssues
>New issue
e descreva o que você quer fazer (feature, bugfix, melhoria) e salve. -
Crie uma Branch:
Abra a página do issue (abre automaticamente quando é criado) e, emDevelopment
, clique emCreate a branch
. Mantenha o nome padrão, deve ser parecido com42-adicionar-modulo-telemetria
.E execute os comandos para alterar a branch localmente na sua máquina:
git fetch origin git checkout -b <numero-da-issue>-<titulo>
-
Faça Commits:
Use mensagens de commit claras:feat(sensor): adicionar módulo de telemetria
-
Crie um Pull Request:
Nomeie o PR com referência à issue:PR#42: Adicionar módulo de telemetria
-
Tests & Reviews:
Teste seu código e aguarde a revisão antes do merge.
<nome-da-branch> ::= <numero-da-issue>-<titulo>
<numero-da-issue> ::= <digito> {<digito>}
<titulo> ::= <lowercase> {<lowercase> | "-"}
<digito> ::= "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"
<lowercase> ::= "a" | "b" | "c" | ... | "z"
Exemplo: 14-corrigir-bug-calculo-orbita
<mensagem> ::= <tipo>(<escopo>): <descrição>
<tipo> ::= "feat" | "fix" | "docs" | "style" | "refactor" | "test" | "chore"
<escopo> ::= <palavra>
<descrição> ::= <palavra> {<palavra>}
<palavra> ::= <lowercase> {<lowercase>}
- Exemplo:
fix(antena): corrigir indexação
<nome-do-pr> ::= "PR#" <numero-da-issue> ":" <descrição>
<descrição> ::= <palavra> {<palavra>}
Exemplo: PR#27: Melhorar algoritmo de navegação
Aqui estão os diagramas de sequência para nossos processos de contribuição:
Eles foram feitos usando o PlantUML. Para compilar, basta instalar o PlantUML com sudo apt install PlantUML -y
e executar o comando make
para buildar as imagens.
-
Se quiser uma documentação melhor de como compilar, sugiro o repositório de diagramas de COM.
-
Se quiser saber como criar um diagrama, veja o site do PlantUML.
Obrigado por contribuir com a Minerva Sats! Se tiver dúvidas, fale com sua gerência ou dê um grito no Discord. Avante! 🚀🛰️