FAQ.md

Dúvidas frequentes

Abaixo estão algumas orientações e dúvidas comuns ao desenvolvimento do projeto.

Se houver qualquer outra dúvida ou problema, é só procurar a monitoria ou postar uma thread no slack. Estamos juntos! 👍

---

Git e GitHub

‼️ Antes de começar a desenvolver

1. Clone o repositório

   • Copie o endereço SSH do repositório e use-o para cloná-lo em sua máquina:

     • Por exemplo: git clone git@github.com:tryber/sd-0x-project-x.git.
     Local do endereço SSH na página inicial do repositório:

     

   • Entre na pasta do repositório que você acabou de clonar:

     • cd <diretório-do-projeto>

2. Crie uma branch a partir da branch main

   • Verifique que você está na branch main
     • Exemplo: git branch
   • Se não estiver, mude para a branch main
     • Exemplo: git checkout main
   • Agora crie uma branch à qual você vai submeter os commits do seu projeto
     • Você deve criar uma branch no seguinte formato: nome-de-usuario-nome-do-projeto
     • Exemplo: git checkout -b joaozinho-project-x

3. Para cada etapa do desenvolvimento, adicione as mudanças ao stage do Git e faça um commit

   • Verifique que as mudanças ainda não estão no stage
     • Exemplo: git status (devem aparecer listadas as alterações realizadas em vermelho)
   • Adicione o novo arquivo ao stage do Git
     • Exemplo:
       • git add . (adicionando todas as mudanças - que estavam em vermelho - ao stage do Git)
       • git status (devem aparecer listadas as alterações realizadas em verde)
   • Faça o commit inicial
     • Exemplo:
       • git commit -m 'Iniciando o projeto X! #VQV 🚀' (fazendo o primeiro commit)
       • git status (deve aparecer uma mensagem tipo nothing to commit )

4. Adicione a sua branch com o novo commit ao repositório remoto

   • Usando o exemplo anterior: git push -u origin joaozinho-sd-0x-project-x

5. Crie um novo Pull Request (PR)

   • Vá até a página de Pull Requests do repositório no GitHub.

     Local da página de Pull Requests no repositório:

     

   • Clique no botão verde "New pull request"

   • Clique na caixa de seleção "Compare" e escolha a sua branch com atenção

   • Clique no botão verde "Create pull request"

   • Adicione uma descrição para o Pull Request e clique no botão verde "Create pull request"

   • Não se preocupe em preencher mais nada por enquanto!

   • Volte até a página de Pull Requests do repositório e confira que o seu Pull Request está criado

⌨️ Durante o desenvolvimento

• Faça commits das alterações que você fizer no código regularmente

• Lembre-se de sempre após um (ou alguns) commits atualizar o repositório remoto

• Os comandos que você utilizará com mais frequência são:

  1. git status (para verificar o que está em vermelho - fora do stage - e o que está em verde - no stage)
  2. git add (para adicionar arquivos ao stage do Git)
  3. git commit (para criar um commit com os arquivos que estão no stage do Git)
  4. git push -u nome-da-branch (para enviar o commit para o repositório remoto na primeira vez que fizer o push de uma nova branch)
  5. git push (para enviar o commit para o repositório remoto após o passo anterior)

🤝 Depois de terminar o desenvolvimento (opcional)

Para sinalizar que o seu projeto está pronto para o "Code Review", faça o seguinte:

• Vá até a página DO SEU Pull Request, adicione a label de "code-review" e marque seus colegas:

  • No menu à direita, clique no link "Labels" e escolha a label code-review;

  • No menu à direita, clique no link "Assignees" e escolha o seu usuário;

  • No menu à direita, clique no link "Reviewers" e digite students, selecione o time tryber/students-sd-0x.

Caso tenha alguma dúvida, aqui tem um video explicativo.

🕵🏿 Revisando um pull request

Use o conteúdo sobre Code Review para te ajudar a revisar os Pull Requests.

Maven

🖥️ Instalando as dependências do projeto

Para instalar as dependências do projeto, basta executar o comando mvn install. Isso irá fazer download das dependências configuradas no pom.xml, além de baixar as dependências indiretas (dependências de dependências).

Caso em um projeto seja necessário fazer alterações no pom.xml, você precisará executar novamente o comando.

É possível também fazer essas tarefas através da sua IDE, caso prefira.

🛠 Rodando os testes com o Maven

Executando todos os testes

Para poder executar os testes, basta executar o comando mvn test e todos os seus testes serão executados.

Executando um teste específico

Para executar um teste expecífico, inicie sua aplicação com mvn test -Dtest=”TestClassName”, utilizando o nome da classe de teste que deseja executar.

Em muitos casos você também pode executar os testes diretamente na sua IDE, mas recomendamos que utilize o Maven para fazer uma verificação final antes de entregar o projeto.

🎛 Rodando o linter (Checkstyle)

Usaremos o Checkstyle para fazer a análise estática do seu código.

Este projeto já vem com as dependências relacionadas ao linter configuradas no arquivo pom.xml.

O Checkstyle já é executado jutamente aos testes. No entanto, caso deseje rodar o Checkstyle manualmente em um projeto, basta executar o comando mvn checkstyle:check.

Você pode também instalar e utilizar o plugin do Checkstyle na sua IDE, mas recomendamos que utilize o Maven para fazer uma verificação final antes de entregar o projeto.

Depois de completar o projeto

🗂 Compartilhe seu portfólio!

Após finalizar os requisitos, chegou a hora de mostrar ao mundo que você aprendeu algo novo! 🚀

Esse passo é super importante para ganhar mais visibilidade no mercado de trabalho, mas também é útil para manter um back-up do seu trabalho.

E você sabia que o LinkedIn é a principal rede social profissional e compartilhar o seu aprendizado lá é muito importante para quem deseja construir uma carreira de sucesso? Compartilhe esse projeto no seu LinkedIn, marque o perfil da Trybe (@trybe) e mostre para a sua rede toda a sua evolução.