Guias de desenvolvimento
Esta seção contém guias completos para desenvolvedores que trabalham no omegaUp.
Links rápidos
-
Padrões de codificação, guias de estilo e práticas recomendadas para PHP, TypeScript e Python.
-
Como escrever e executar testes para testes PHP, TypeScript e Cypress E2E.
-
Compreender os padrões DAO/VO e as melhores práticas de interação com o banco de dados.
-
Desenvolvimento de componentes Vue.js e integração com Storybook.
-
Comandos e atalhos comuns de desenvolvimento.
Fluxo de trabalho de desenvolvimento
- Configure seu ambiente - Coloque o Docker em execução
- Leia as diretrizes de codificação - Entenda nossos padrões
- Escrever testes - Certifique-se de que seu código funcione
- Envie um PR - Contribua com suas alterações
Princípios Chave
Digite Segurança
- Todo código deve declarar tipos de dados
- TypeScript para front-end
- Salmo para PHP
- mypy para Python
Teste
- Todas as alterações de funcionalidade devem incluir testes
- Os testes devem passar 100% antes de serem confirmados
- Escreva os testes primeiro, quando possível
Qualidade do código
- Siga regras automatizadas de linting
- Use cláusulas de guarda em vez de condicionais aninhadas
- Minimize o uso nulo/indefinido
- Remova o código não utilizado (não comente)
Documentação Relacionada
- Visão geral da arquitetura - Design do sistema
- Referência da API - Documentação da API
- Primeiros passos - Guia de configuração e contribuição
Pronto para codificar? Comece com Diretrizes de codificação!