O Mentor Cycle é uma iniciativa open-source que tem como objetivo conectar pessoas na área de T.I que estão buscando aprendizado com profissionais experientes do mercado. A plataforma realiza o match entre aprendiz e mentor, proporcionando ao iniciante um guia que já vivenciou e superou os desafios que o mesmo está enfrentando, tornando a jornada de estudos mais produtiva e eficiente.
Para entender melhor o projeto, você pode assistir esse vídeo que mostra uma visão macro da plataforma:
Antes de tudo precisamos ter as seguintes ferramentas instaladas na sua máquina:
- Node.js (Nosso projeto utiliza Yarn, use-o para uma melhor experiência)
- Git
- Visual Studio Code ou similar
- Para encontrar uma tarefa disponível para contribuir, acesse o Github Projects e localize a coluna "Para Fazer". Clique em um card que lhe interesse e deixe um comentário para indicar que você irá trabalhar nesta tarefa. Em seguida, arraste o card para a coluna "Em progresso". A partir deste momento, você será responsável pela entrega da tarefa selecionada.
obs: Certifique-se de verificar as descrições e comentários da tarefa para entender completamente os requisitos e as expectativas de entrega. - Agora vá até o repositório Front-end, baseado na tarefa que você escolheu você irá fazer um "Fork" da aplicação, para isso você precisa abrir o repositório no GitHub e clicar em "fork", do lado superior direito conforme na imagem:
obs: É importante que você faça o "fork" do projeto e não um "clone", se estiver com dúvidas sobre fork leia aqui.
O objetivo do Fork é criar uma cópia do repositório na sua conta do GitHub, permitindo que você trabalhe nele sem afetar o projeto principal. É importante lembrar que você nunca deve enviar Pull Requests diretamente para o repositório principal do projeto, pois isso não é permitido pelo sistema. Após o Fork, você terá um repositório com o seguinte nome: `seu_nome_de_usuario/mentor-cycle-fe`, como mostrado abaixo:
3. Agora que você fez o fork do repositório, é hora de cloná-lo para sua máquina local. Para fazer isso, vá para o seu repositório recém-criado na sua conta GitHub (lembre-se de que ele deve ter o nome seu_nome_de_usuario/mentor-cycle-fe). Em seguida, clique no botão "Code" e copie o link do repositório usando o botão "Copy" ao lado.
Clonar um repositório significa baixa-lo para a sua máquina mantendo uma conexão com o GitHub
git clone https://github.com/seu_nome_de_usuario/mentor-cycle-fe.git
- Com repositório na sua máquina, basta você abri-lo com seu editor de código favorito, em seguida executar o comando:
yarn install- é necessário criar um arquivo .env na raiz do projeto e adicionar o seguinte código la dentro:
NEXT_PUBLIC_BACKEND_URL=https://mentor-cycle-be-dev-160e.up.railway.appIsso fará com que o gerenciador de pacotes do node, baixe todas as dependências necessárias para rodar, finalizado a instalação rode o comando:
yarn dev- Agora com tudo instalado e rodando, basta você criar a sua branch, executar a sua tarefa e após finalizado lembrar-se de adicionar ao stage com os seguintes comandos:
Criar branch:
git checkout -b nome_da_branchAdicionando arquivos:
git add .Adicione uma mensagem de commit com o comando:
git commit -m "sua_mensagem_aqui"Neste passo lembre-se de utilizar uma mensagem em inglês e também descrevendo o que você fez com poucas palavras e o padrão de commits, por exemplo "feat: create user endpoint"
e em seguida suba as alterações para o seu repositório fork com o comando:
git push- Hora do pull request, após dar o
git push, ao abrir o seu repositório fork na página do GitHub, você notará que existe uma mensagem logo no topo assim como essa:
Vendo isso, clique no botão "Compare & pull request", isso começara o processo de abertura de uma PR(Pull Request) e lembre se de apontar sempre para a branch dev do projeto Mentor Cycle . Esse passo é muito importante, pois existem pessoas responsáveis nas Reviews, que irão validar o que você fez e caso tenha algo errado ou que possa ser melhorado elas irão comentar. Isso ajudará muito na sua evolução.
Lembre se de colocar o título conforme o tipo da tarefa, uma mensagem que descreva o que você fez, se possível anexar uma captura de tela e colocar o Link do card da tarefa do Trello que você pegou, pode seguir este modelo ficando mais ou menos assim:
Pronto, feito isso, é só aguardar a análise da sua PR, você será notificado caso seja aprovada ou o revisor solicite alguma alteração, BORA PRA CIMA!!!! 🚀🚀🚀
