Dicas de Desenvolvimento

Este repositório é colaborativo e tem como objetivo reunir dicas legais de desenvolvimento.

---

Dicas

1. Se você não vai usar o dado para cálculos prefira armazená-lo como string.

   1. Nunca valide o campo de CPF como inteiro, use o tipo string. Por exemplo: Se o CPF é 050.***.***.***-** irá ficar 50*.***.***-*.

2. Armazene só o que é necessário no dado. Não armazene caracteres de formatação. (ex. 12345678901 e não 123.456.789-01.

3. Evite usar dados de negócio (ex. CPF, RG, placa de carro) na criação da sua modelagem. A estrutura, formato e função destes dados pode mudar com o tempo e quebrar a sua modelagem.

   1. Não use CPF como chave primária de uma tabela. Usar um índice do tipo UNIQUE melhor.
   2. Não confie muito no formato do dado para criar regras. Lembrem-se que as placas de carro brasileiras tinham só 2 letras, depois 3 letras e agora tem uma mistura de letras e números. Os CEPs brasileiros tinham 5 dígitos e agora tem 8.

4. Tente armazenar as datas em um timezone neutro (ex. UTC) e fazer as conversões para o timezone adequado apenas para entrada e saída dessa informação.

   1. Em alguns casos raros pode ser necessário saber o horário em que a ação ocorreu no local (ex. o vendedor postou a encomenda no horário comercial de Manaus onde ele mora?). Nesses casos grave as duas informações separadamente (ex. uma coluna com a data/hora UTC e outra com a data/hora local). Isso simplifica fazer operações com essas datas sem ter que ficar consultando alterações de timezone (ex. no ano em questão teve horário de verão nessa data? nesse país/estado?

5. Tenha curiosidade em entender como funciona a tecnologia que você usa.

   1. Não fique na zona de conforto de linguagens e frameworks. Procure entender como funciona "por debaixo dos panos" para assim você ter mais facilidade ao resolver um problema que possa ocorrer. Pesquise sobre conceitos de computação como Estruturas de Dados e Programação Orientada a Objetos, assim há chances de otimizar cada vez mais seu código.

6. Ao desenvolver uma feature / projeto novo, tente fazer a versão mais simples do projeto, foque no MVP.

   1. Não se apegue a coisas como "qual tipo de autenticação devo usar ?", "qual é a forma mais performática de fazer isso?", na grande maioria das vezes é muito melhor desenvolver a solução e depois refatorar, isso pode te salvar muito tempo que você gastaria tentando fazer da melhor forma desde a primeira vez.

7. Sempre valide dados de input dos usuários, tanto no frontend como no backend.

   1. Ao validarmos apenas um deles, deixamos a aplicação vulnerável a requests maliciosos.
   2. A validação de entrada pode ser implementada usando qualquer técnica de programação que permita validar efetivamente a sintática e semântica, por exemplo:
      1. Validação em relação ao esquema JSON e XML Schema (XSD) para entrada nesses formatos.
      2. Expressões regulares para qualquer outro dado estruturado que cubra toda a cadeia de entrada (^ ... $) e que não use o "qualquer character" (como. Ou \ S).
      3. Array de valores permitidos para pequenos conjuntos de strings (por exemplo, dias da semana).

🤝 Contribuindo

Todo tipo de contribuição é bem-vinda, nós admiramos isso!

Tem algum problema? Encontrou um bug ou exercício incorreto? Tem alguma dica? Abra uma issue descrevendo.

Quer contribuir com código? Pedimos que antes leia este guia de contribuição

Não esqueça de deixar a sua ⭐, também é um modo de contribuir com o projeto ;)

---

Criado por Ana no Terminal ❤️