kvlsndkf / project

Heelp é a nova rede social dos etequianos, ela veio para facilitar a comunicação e aumentar o network entre os alunos. Além dar uma mão na resolução de tarefas, ainda traz uma experiência gameficada.

Seja bem vindo repô do Heelp!

📘 Sumário

Skills necessárias
Criando pull request
Aprovando uma PR
Critérios de aprovação
Merge
Mantenha o seu repositório local sempre atualizado

🚀 Skills necessárias

Sobre o Heelp!

Heelp é a nova rede social dos etequianos, ela veio para facilitar a comunicação e aumentar o network entre os alunos. Além dar uma mão na resolução de tarefas, ainda traz uma experiência gameficada. Quer saber mais?! acesse: youtube.

👨🏻‍💻 Primeiros passos

🚨 Atenção: Não esqueça estar com o token do github criado.

Para iniciar a sua jornada, você deverá ter o repositório salvo localmente para isso siga os passos:

1. Entre na página do repositório e procure pelo botão code;
2. Copie o código HTTP disponibilizado;
3. No seu terminal, digite cd /;
4. Em seguida, digite cd xampp/htdocs;
5. E dê o comando git clone <url>;
6. Ainda no terminal, entre na pasta do repositório cd <nomePasta>;
7. Com o repositório na sua máquina passe da main, para a branch QA git checkout qa.

📌 Nota: Certifique-se de estar em QA quando inciar qualquer tipo de alteração no repositório.

😎 Pronto! Agora você terá o repositório salvo na sua máquina e pronto para iniciar as suas tasks. 🎯

🔄 Criando Pull Request (PR)

Não poderá ser feito nenhum commit do repositório local diretamente para a main localizada no repositório remoto.

Para você fazer o seu deploy, deverá abrir uma branch referente a sua task e fazer uma PR direcionada para QA, desta forma os integrantes do grupo poderão revisar o seu código, assim, tendo códigos de maior qualidade e mantendo todo o time atualizado. Segue abaixo os passos para subir a sua PR:

⚠️ Supondo que você está na branch de QA, você poderá seguir esses passos.

🚨 Atenção: para nomear a sua branch existem duas formas:

• feat/nome-da-tarefa : Para novas tarefas;
• fix/nome-da-tarefa-de-correcao : Para corrigir BUGs de problemas que são existentes em QA (BRANCHS QUE JÁ FORAM MERGIADAS).

1. Crie a sua branch git checkout -B <feat ou fix/nome-da-task>;
2. git add --all
3. git commit -m "descricao-do-que-vc-fez";

4. Suba as alterações feitas para a sua branch git push;
5. No seu terminal o git dará um código, copie e cole para finalizar o processo de envio;
6. Crie sua pull request, apertando no botão Compare & pull request;
7. Coloque a descrição do que você fez na sua task;
8. Adicione o seu perfil como autor da PR em Assigners;
9. Coloque as pessoas para que elas lembrem-se de revisar em Reviwers;
10. Coloque a label code review;
11. Coloque o link da sua PR no seu cartão do Trello e envie no grupo do WhatsApp.

✅ Agora é só aguardar o approve da squad! 🎉

🔍 Aprovando uma PR

1. Entre no link do Trello;
2. Ao entrar no link da pr, procure pela aba Files changed;
3. Aparecerá todo o código, em vermelho: foram as linhas deletedas, e em verde: são as linhas adicionadas;
4. Analise com atenção;

📌 Nota: para que a revisão fique ainda melhor podemos ver o que a pessoa fez direto no nosso navegador!
Rápido, prático e fácil! Basta no seu terminal dar um git checkout <nome-branch-colega> e você acessará diretamente!

❌ Caso encontre algo de errado,

5. Passe o mouse na linha do erro encontrado e irá aparecer um botão azul com sinal de +;
6. Ao clicar irá aparecer o espaço para o comentário;
7. Depois que fizer o comentário, coloque um artigo sobre a sua observação. Além de dar credibilidade ao seu ponto, também dará a possibilidade da pessoa entender o que houve e conseguir arrumar;
8. Após colocar os comentários, procure pelo botão Finish your review;
9. Escolha a opção Request changes;
10. Envie comentario apertando em submit review;
11. Comente na task do trello "revisado/solicitação de alteração".

Se encontraram algo de errado na sua PR, não entre em desespero! 🤪

😎 É muito fácil corrigir, certifique-se de que esteja na sua branch que precisa de correção, para isso dê o comando no terminal git branch, a partir dele você irá conseguir ver todas as branchs que você já acessou, e também irá ver a branch que você está... sendo mostrada na cor verde!
✏️ Agora estando na sua branch, faça as alterações necessárias!
💻 Por fim, depois de ter corrigido todos os pontos dê um git add --all, git commit -m "descricao-do-que-vc-fez" e por fim um git push.
🔉 Todas as alterações serão enviadas para a branch, não se esqueça de avisar os seus colegas e adicionar a label WAITING.
✅ PR prontinha para ser corrigida! ✅

✅ Caso não encontre nenhum erro

5. Na aba Files changed, procure pelo botão Finish your review;
6. Escolha a opção Approve;
7. Aparecerá um campo, comente "revisado/aprovado";
8. Envie comentario apertando em submit review;
9. Comenta na task do trello também "revisado/aprovado".

🚦 Critérios de aprovação

Para que uma PR seja aprovada e fique disponível para merge, ela pecisa ter o approve de 5 integrantes do grupo 🧔🏾 👩🏻‍🦰 🧑🏻 👩🏼‍🦳 👦🏽

FAÇA REVISÕES SEMPRE QUE POSSÍVEL! O caminhar do próximo depende de você. Seja responsável, mantenha o seu trabalho e o do próximo camihando de forma fluída.

↕️ Merge

⚠️⚠️ Essa é uma estapa de extrema atenção!

Regra para o merge das tasks:

• Só serão as tasks que estão revisadas e sem bugs;
• Tarefas que tem o total de approves necessários;
• E só poderá ser feita de Segunda à Sexta.

🚨 Será feito o merge de QA para main aos domingos.

📆 Testes e prazos

As tasks terão o prazo de uma semana para serem entregues, ou seja, toda semana deverá ter entregas.
Aos sábados os QA's realizarão os testes na branch de QA.
Durante a semana, todos farão testes em QA.

⚠️ Para o teste será levado em conta o tipo de task e o resultado esperado.

🤩 Mantenha o seu repositório local sempre atualizado

1. Faça a atualização aos domingo (neste dia está proibido fazer merge);
2. Certifique-se de que todos os merges do dia foram feitos;
3. E de que QA não esteja quebrada ou com bugs;
4. Para atualizar digite git checkout main; para ter certeza de que você está na branch correta
5. git pull;

😍 Repositório lindo, sem bugs e atualizadinho! 😌