Instituto dos Cegos

Este é o repositório da aplicação frontend do projeto IDC desenvolvido em ReactJS pela equipe do Inove.

---

🚀 Execução

1. Faça um clone desse repositório rodando:
   git clone https://github.com/dev-inove/IDC-frontend.git;
2. Entre na pasta rodando pelo terminal: cd IDC-frontend;
3. Rode npm install ou yarn caso utilize para instalar as dependências do projeto;
4. Rode npx start ou yarn dev caso utilize para iniciar o site.

---

🤔 Padrões de contribuição

Se quiser contribuir para esse repositório aqui, seja corrigindo algum problema, adicionando comentários ou melhorando a documentação, você pode seguir esse tutorial abaixo:

1. faça as etapas 1 e 2 do tutorial de execução

• Faça o checkout da branch de desenvolvimento usando o comando git

checkout dev

• Crie uma nova branch para a sua tarefa com o comando

git checkout -b nome-da-branch

Onde "nome-da-branch" deve seguir o padrão "IDC-23-[inicial do time][número da task com 3 digitos] - [tipo de commit] - [descrição-curta]".

Exemplo: "IDC-23-F001 - feature - implementar login"

• Faça as alterações no código necessárias para completar a task e faça commits com mensagens descritivas e claras.

tipo de commit	palavra-chave
commit inicial	init
novo recurso	feat
teste	test
correção de bugs	fix
refatoração	refac

• Quando possivel faça apenas um commit por task.

😅 Terminei de implementar a task. E agora?

• Quando a task estiver completa e testada, abra um pull request (PR) da branch criada para a branch dev. Para isso entre no repositório e observe que vai aparecer um alerta com a opção compare & pull request. Clique nesse botão!

• Lembre-se de trocar a branch que vai ser receber o merge para dev.

• Tudo certo, agora o lider do seu time vai revisar e avaliar o código.

• Aguarde a aprovação e, se necessário, faça as alterações sugeridas.

• Quando o PR for aprovado, faça o merge da PR para a branch dev e delete sua branch.

✉️ Padrões de commit

para um commit:

git fetch -all
git push origin dev

para mais de um commit:

git fetch -all
git rebase origin/dev
git push origin dev

Lembre-se de seguir essas práticas cada vez que trabalhar em uma nova task. Isso ajudará a manter o código organizado e fácil de entender, além de facilitar a revisão e aprovação de código pelos membros da equipe. Se você tiver alguma dúvida, não hesite em perguntar aos seus colegas de equipe

---

Feito com ♥ by Inove 👋