CaronaBoard

Getting started

Prepare seu ambiente seguindo este LINK

1. yarn install
2. yarn run ios isso irá abrir o seu iOS simulator, caso queria rodar o android você precisa abrir o emulador android e rodar yarn run android
3. Você precisará preencher o arquivo .env com os valores para cada entrada. Você pode pedir os valores AQUI
4. Erros comuns e suas soluções serão documentadas AQUI

Todos comandos yarn podem ser substituidos por npm

Git Hooks

O projeto tem githooks configurados através do Husky🐶, os hooks podem ser encontrados no package.json. Basicamente a cada tentativa de commit será verificado de o código está seguinte o guia de estilo StandardJS alguns erros podem ser consertados automaticamente através de yarn run lint-fix. A cada tentativa de commit será verificado se os testes estão passando, estamos guardando snapshots de cada componente de UI. Caso tenha feito alguma mudança intencional de UI é só rodar yarn run update-snapshot e commitar os arquivos que foram atualizados.

Contribuindo

Você pode contribuir com o CaronaBoard de duas formas:

Contribuições não técnicas

Estamos abertos a sugestões de melhorias, novas features, correções de bugs, melhorias em usabilidade/acessibilidade, etc. Esses tipos de colaboração devem ser feitas através de Issues é só criar uma nova issue que respoderemos assim que possível.

Contribuições técnicas

Caso tenha alguma sugestão de implementação, melhoria de código, etc. Fique à vontade para criar um pull request. Será necessário que você crie um fork do repositório do CaronaBoard antes de criar o PR. Antes das mudanças serem mergeadas na master será necessária a aprovação de um admin do repositório e que CI passe (Consulte a seção Integração Continua da wiki para mais informações)