CONTRIBUTING.md 1.91 KB

Guia de Contribuição - Como contribuir com o Protocolo Eletrônico?

Gostou do nosso projeto e deseja contribuir de alguma forma? Comece por aqui!

Você achou algum bug?

  • Verifique se ele já não foi reportado procurando na seção de issues do projeto.

  • Se você não encontrar nenhum report para o bug encontrado, crie uma nova. Fique atento para incluir um título e uma descrição clara, com a maior quantidade de informações relevantes possível. Preferencialmente, inclua um trecho de código, anexos e uma execução passo a passo para a reprodução do problema, informando o resultado esperado.

Você deseja adicionar alguma correção de bug ou uma nova funcionalidade?

  • Verifique se já existe alguma issue relacionada, procurando na seção de issues do projeto.

  • Caso não exista, crie uma nova. Certifique-se de adicionar um título e descrição clara do que foi realizado.

  • As adições devem ser feitas através de *pull requests*.

Como contribuir através de pull requests?

Para contribuir com o projeto é muito fácil, basta seguir os seguintes passos:

  • Clone o repositório

    • Clone o repositório no seu ambiente
  • Criar issues

    • Crie uma issue relacionada com o que deseja adicionar no projeto.
    • Certifique-se de adicionar um título e descrição clara do que foi realizado.
  • Criar branchs

    • Crie uma branch com o mesmo nome da issue aberta.
    • Trabalhe na sua modificação
  • Submeter Pull Request

    • Crie um pull request com o mesmo nome da branch criada, para o branch master.