Skip to content

Latest commit

 

History

History
50 lines (29 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

50 lines (29 loc) · 1.59 KB

Como contribuir com o projeto?

Como instalar o projeto?

Tecnologias

Este projeto usa

Pre Requisitos de Ambiente

É necessário ter instalado:

Processo de desenvolvimento

Se for contribuir a nível de desenvolvimento, primeiramente faça um fork o projeto, e depois siga as etapas abaixo

  1. Instale as dependências
yarn
  1. Subindo o projeto
yarn start

Como reportar problemas ou sugestões?

Encontrou algum problema? Algo não funcionando corretamente? Tem alguma sugestão de informação a ser usada? Abra uma ISSUE para o projeto.

ISSUEs são a melhor forma de se reportar problemas ou sugestões, pois tudo fica documentado, desde o report até a sua resolução e ainda fica como histórico do projeto.

Para abrir uma ISSUE, acesse aqui. Algumas dicas:

  • Use uma linguagem clara
  • Se a ISSUE reportar um problema, se possível, dê sugestões de como resolver, isso demostra interesse na melhoria do projeto.

Boas práticas para o Pull Request

Confira o tutorial da Atlassian sobre Pull Requests

Se o PR for algo relacionado a uma ISSUE, por exemplo, com o código que resolve o que está nela, pedimos que no título do PR, use o identificador da ISSUE, por exemplo, "Close issue #10". Isso fará com que automaticamente o Github entenda que o PR está relacionado com a ISSUE.