Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 2 KB

contributing.md

File metadata and controls

53 lines (41 loc) · 2 KB

Bem-vindo ao guia de contribuição

Obrigado por se interessar em contribuir com o projeto. Esse guia dará um overview do fluxo de contribuição, desde abrir uma issue até o código ser mesclado ao repositório principal.

Issues

Abrindo uma issue

Se você encontrou algum problema com o CLI, verifique se existe alguma issue já aberta. Caso não exista, você pode abrir uma seguindo o padrão abaixo.

Descrição

Adicionar uma descrição do problema que ocorrreu e precisa ser resolvido ou de uma sugestão de melhoria

Motivo

Explicar o motivo que gerou essa issue e porque ela precisa ser resolvida.

Detalhes

Adicione mais detalhes do problema ou da sugestão.

Comportamento esperado

Especifique o comportamento que acredita ser o correto. Atenção: Esse item deve ser usado somente quando for reportar problemas.

Comportamento encontrado

Especifique o comportamento encontrado e que acredita ser incorreto. Atenção: Esse item deve ser usado somente quando for reportar problemas.

Resolvendo uma issue

Verifique as issues abertas e encontre uma que lhe interesse. Você poderá usar labels para filtrar as issues abertas. Como regra geral, uma issue não é atribuida a ninguem. Caso tenha a correção para uma issue, você pode abrir uma pull request com a correção

Pull Requests

Quando finalizar as modificações feitas para corrigir um problema, crie uma pull request, também conhecida como PR. Lembre-se de linkar as issues resolvidas no corpo da PR.

A PR será revisada pelo nosso pessoal e informações adicionais poderão ser solicitadas, como também alterações.

Utilize o formato abaixo ao criar sua Pull Request.

Descrição da mudança

Descrever as mudanças feitas para corrigir os problemas reportados.

Issues

Linkar issues que foram resolvidas com essa PR.

Adicional - Opcional

Detalhes adicionais que acha interessante colocar para ajudar o processo de revisão. .