Seguir o padrão de estilo de código definido para o projeto
- Nomenclatura de em inglês.
- Indentação do código.
Não reinventar a roda
- Manter a estrutura de pastas definada.
- Verifique se o que você precisa já não foi criado (componente ou método), antes de sair codando.
Garantir que o código é legivél
- Lembre-se que haverá revisão de código por outros membros do time, portanto tente o deixar mais legível possível para um melhor entendimento, e para reuso de outros membros da equipe para demais tarefas que possam a vir a necessitar a utilizar o foi criado por ti.
Comentar e Documentar
- Todos são responsáveis pela qualidade do código, sugestões e novas ideias são bem vindas, caso tenha alguma ideia ou insight sobre algo que poderia ser melhor, comente com o time.
Teste o seu código
- Valida o que foi feito, fazendo um teste de ponta a ponta caso houver integração na tarefa que esteja fazendo, em caso contrario, valide com mocks a tarefa criada no front, ou pelo postman fazendo requisições para o backend.
Evitar hard-coding
- Sempre que possível evite valores soltos no código a qualquer custo, em vez disso utilize constates e especifique um nome descritivo que dê significado a aquele valor.
Nomes descritivos ou contextuais
- Ao nomear métodos, variáveis, constantes, classes, etc. Busque dar nome descritivos a funcionalidade, ou ao seu contexto.
Colaboração
- Ajude quando puder e peça ajuda quando precisar, somos um time.
Marcelo Henrique De Souza