Mentor Cycle
💻 Projeto
O Mentor Cycle é um projeto open-source cujo objetivo é conectar pessoas na área de T.I que estão aprendendo, com profissionais com experiência de mercado, fazendo o match entre aprendiz e mentor. Isso faz com que o iniciante tenha uma pessoa que já vivenciou aquilo que o mesmo está procurando aprender, facilitando sua jornada de estudos e metas.
Para entender melhor o projeto, você pode assistir esse vídeo que mostra uma visão macro da plataforma:
🤔 Como contribuir
Agora que você já sabe como funciona, bora ver os passos para contribuir com o projeto! 🚀🚀🚀
Para tarefas de UI/UX, siga os processos baseados no time, caso tenha dúvida entre em contato pelo Discord ou na Comunidade Whatsapp.
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
Caso você esteja fazendo uma tarefa Front-end e necessite do Layout, role até o fim da página e acesse o link do figma.
- Entre no Github Projects e veja as tarefas que estão na coluna "A Fazer", lá você pode escolher um card, clicar nele, assine-o para você e arraste a tarefa para a coluna "Em Progresso". A partir daí você já estará responsável pela entrega desta tarefa OBS: se você não for um membro, apenas coloque um comentário que está responsavel por essa task:
- Agora vá até a aba "Repositórios" e escolha um repositório, lembrando que existem repositórios Front-end e Back-end, baseado na tarefa que você escolheu você irá fazer um "Fork" da aplicação, para isso você precisa abrir o repositório escolhido e clicar em "fork", do lado superior direito conforma na imagem:
O Fork visa criar um clone desse repositório na sua conta GitHub, e é lá que você irá trabalhar no projeto, nunca submeta PRs diretamente do repositório da organização, existe uma trava que não permitirá que você faça isso, então caso tenha algum erro, reveja esse passo. Após fazer o fork você deverá ter um repositório com o seguinte nome:
seu_nome_de_usuario/nome_do_repositorio como está aqui:
- Após fazer o Fork, você irá clonar o repositório criado da sua conta, lembrando, você clonar o repositório
seu_nome_de_usuario/nome_do_repositorioe não oMentor-Cycle/nome_do_repositorio.
Clonar um repositório significa baixa-lo para a sua máquina mantendo uma conexão com o GitHub
Para clonar basta você clicar no botão "<> Code" e copiar o link que aparecerá na tela, após isso va até seu terminal e digite o seguinte comando:
git clone codigo_que_voce_copiouNo meu caso estou clonando o repositório Back-end como exemplo, então o comando ficará assim:
git clone https://github.com/oliveirabalsa/mentor-cycle-be.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- Para ter a aplicação utilizável, é necessário adicionar um arquivo .env na raiz do projeto. Para obter esse arquivo peça a algum mentor ou lider em nosso canal do Discord.
Isso 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 start:dev- Agora com tudo instalado e rodando, basta você criar a sua branch, executar a sua tarefa e após finalizado lembre se adicionar ao stage como o comando:
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 da 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 e também adicionar 2 pessoas para revisar a sua tarefa. Esse passo é muito importante, pois essas pessoas 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!!!! 🚀🚀🚀
Nossas redes sociais
Developed by Leonardo Balsalobre :copyright:
A progressive Node.js framework for building efficient and scalable server-side applications.
