Utilização em projetos
Last updated
Last updated
Na Struct usamos o Git como ferramenta para gerenciamento de versões em todos os nossos projetos, usando o GitHub para armazenamento de todos. Como membro da Struct, você deve passar seu usuário do GitHub para a diretoria da empresa quando for solicitado durante sua efetivação. Após isso, você será adicionado ao time da Struct no site e terá acesso aos repositórios da empresa.
Como membro da empresa será esperado que você siga alguns padrões e boas práticas durante seu uso do Github, a fim de garantir a organização dos nossos repositórios.
Quando você for designado a uma Issue em um projeto, a primeira coisa que você deve fazer é criar uma branch do código para trabalhar. Nessa etapa, lembre-se sempre de criar a branch a partir da main/master e de, antes de criá-la, dar git pull no código, para garantir que você está trabalhando na versão mais atualizada do código.
Na Struct seguimos um padrão de nome para dar para a branch. A primeira coisa a saber é qual o número da sua Issue no Github (você pode ver isso ao lado do nome dela na página da Issue). Com isso em mãos, começamos o nome da branch com o seu número (com três dígitos) e escrevemos resumidamente o propósito da Issue, separando tudo por _.
Como exemplo, se estamos trabalhando na Issue de número #28 para criação de uma página de login, um possível nome para nossa branch seria 028_pagina_login.
Ao trabalhar em uma issue durante um projeto, evite fazer todo o trabalho em só um commit. Divida a funcionalidade a serem realizadas em partes, e faça um commit para cada uma das partes.
Por exemplo, se você está trabalhando em uma issue de criação de uma página de login completa, poderíamos dividir a tarefa nas seguintes etapas (cada uma representando um commit):
| Descrição da Tarefa | |
|---|---|
Algumas issues menores, como de correção de bugs, podem ser feitas com apenas um commit. Organize suas tarefas antes de começar para prever quantos commits serão necessários.
O Github permite que emojis sejam incluídos nas descrições dos commits usando atalhos. Os emojis devem ser a primeira coisa adicionada a descrição do commit e indica que tipo de tarefa foi realizada nele. Alguns exemplos mais usados de emojis, seus atalhos e significados podem ser vistos abaixo:
Para a lista completa de emojis que podem ser usados nos commits, use o site gitmoji.
Na Struct nós usamos a descrição dos commits apenas para identificar o que foi feito, sem necessidade de descrever como foi feito nem dar maiores detalhes (isso fica nos Pull Requests). Com isso em mente, sempre escreva descrições curtas e bem descritivas do que foi feito.
❌ O que não fazer:
correcoes feitas
Aprimorado UI da página de login usando padrão definido no figma e react-responsive-caroussel no carrossel
✅ O que fazer:
🐛 Imagens não aparecendo no login corrigido
💄 Estilização da página de login
Dica: use o comando git commit -m "<Descrição aqui>" para dar o commit e escrever a mensagem em apenas uma linha.
Embora pareça ser algo básico, muitas pessoas não testam seu código por completo antes de realizar um Pull Request. Ao fim da Issue, tente testar tudo que você programou, e, caso tenha modificado algum código usado por outras partes do projeto (um método ou um componente por exemplo), verifique as partes do programa, tanto no back quanto no front, que usam ele, e garanta que elas não tenham sido quebradas pelas suas modificações.
No caso de você estar fazendo uma Issue do Backend, caso tenha sido criadas ou modificadas models ou controllers, lembre-se se criar ou atualizar os testes em RSpec de tudo que for feito por você na Issue.
Além disso, rode todos os testes de RSpec criados, a fim de verificar se seu código continua passando em todos.
Em casos de se estar trabalhando no Backend da aplicação, execute também o rubocop ao final de sua programação, a fim de conferir se seu código segue bons padrões de escrita.
Com tudo no seu código feito e testado, seguindo o que foi pedido na sua Issue, só falta você criar seu Pull Request no Github. Dê um git push na sua branch e já deve aparecer na página principal do projeto a opção de criar o PR.
Por padrão, o Github irá colocar como nome do Pull Request o nome da sua branch ou o nome do commit feito (caso só haja um commit). Embora não exigimos que os membros da Struct troquem esse nome na criação do PR, é recomendado que coloque um nome mais descritivo, se o nome automático já não estiver.
Esse é o momento de dar maiores detalhes sobre o que você fez e como foi feito, contendo as seguintes informações:
O que foi feito
Comece listando tudo o que foi feito na sua branch, tanto as coisas que já estavam definidas em sua Issue quanto outras coisas que você teve que modificar para deixar tudo funcional. Use essa etapa para ir na seção do Github de arquivos modificados do Pull Request e revisar tudo o que foi feito, detalhando isso na descrição do PR.
Como foi feito
Aqui você descreverá como você executou o que foi detalhado na etapa anterior. Você corrigiu um bug? Detalhe o que estava causando ele e o que você fez para corrigir. Utilizou uma gem/componente externo? Detalhe qual foi e qual foi seu motivo de utilizá-lo. Tudo que você achar relevante de falar sobre o que foi feito em seu código é para estar aqui.
Como foi testado
Nessa etapa detalhe o que você fez para garantir que seu código estava funcionando. Em alguns casos, em especial no front, somente citar que todas as páginas modificadas foram acessadas e todas as possibilidades de ações do cliente nelas foram testadas já é o suficiente. Qualquer coisa a mais que você fizer para validar o funcionamento vale a pena ser citado aqui. Para o Back, informe sobre os testes RSpec criados e testados, e também sobre quais outras formas você testou os métodos criados (Insomnia, Rails Console...). Novamente, qualquer coisa diferente usada para testagem detalhe aqui também.
Responsividade
Para o caso de Issues no front, detalhe também sobre como sua implementação está funcionando em diferentes tamanhos de telas, sendo os mais importantes os seguintes:
Smartphone
Tablet
1024
1280
1440
1920
Template
Para evitar esquecer qualquer coisa na hora de descrever seu Pull Request, siga o template a seguir:
| Emoji | Atalho | Significado |
|---|---|---|
Tarefa 1
Criar base da página no HTML (Inserir headers, textos, campos e imagens)
Tarefa 2
Estilizar página (CSS)
Tarefa 3
Adicionar animações
Tarefa 4
Integrar com a API
🐛
:bug:
Correção de um bug
✨
:sparkles:
Nova funcionalidade
💄
:lipstick:
Atualização na UI e nos arquivos de estilização
✅
:white_check_mark:
Adição, atualização ou passagem de testes
🔀
:twisted_rightwards_arrows:
Merge de branches
📱
:iphone:
Responsividade de páginas
⚡
:zap:
Melhoria na performance do código