Em primeiro lugar, obrigado por investir seu tempo para contribuir com o nosso projeto! Qualquer contribuição que for feita irá refletir no produto final.
Neste guia você terá uma visão geral de como abrir uma issue, criar um PR, revisar, e mergar um PR. Leia nosso Código de Conduta para mantermos uma comunidade saudável.
Criar um padrão de como contribuir para com o projeto FGAtlas. Visando desenvolver um ambiente de produção mais organizado, coeso, seguro, e produtivo.
Para ter uma noção geral do código ler a README. A seguir estão alguns recursos para
auxiliar no aprendizado de como contribuir com códigos abertos.
Olhe os tipos de contribuição que aceitamos antes de fazer qualquer alteração. Algumas contribuições não requerem
nenhuma linha de código.
- Criar uma issue:
- Se você localizar um problema,
procure se já não existe uma issue. Se uma issue relacionada ao problema não existir, você pode abrir uma usando o seguinte
template: Issue template
- Resolvendo uma issue:
- Olhe as nossas issues abertas para achar uma de seu interesse. Você pode filtrar sua busca utilizando 'labels'. Veja Labels para mais informações. Temos como regra geral, não atribuir issues a outros. Se você encontrar uma issue para trabalhar, você é mais que bem-vindo para abrir um PR com a solução.
Quando finalizar as alterações de algum arquivo, código ou documento, crie um pull request, também conhecido como PR.
- Preencha o “Ready for review” para que alguém revise seu PR. Para fazer isso, siga o template de PR do projeto. Esse template ajuda aos revisores a
entender suas mudanças e o propósito do seu PR;
- Não se esqueça de fazer o link com uma issue se você estiver resolvendo uma;
- Se ocorrer qualquer problema no merge, olhe esse tutorial git para lhe ajudar a solucionar o problema.
Esse guia de contribuição foi baseado no CONTRIBUTING.mg
| Versão | Data da alteração | Alteração | Responsável | Revisor | Data de revisão |
|---|---|---|---|---|---|
| 1.0 | 12/09/2023 | Criando documento | Rafael Bosi | Lucas Gobbi | 14/09/2023 |