Padrões além do código

Uma boa arquitetura, padrões de código e workflow bem definido podem fazer nossa vida de dev ficar muito mais simples e garantir segurança.

A ideia dessa talk é mostrar o que esses 15 anos de dev e php conference me ensinaram e como eu consegui implementar documentações e
definições que ajudam desde Júnior a Sênior.

Transcript

1. Padrões além do código
2. @ivanrosolen Ivan Rosolen Desenvolvedor há ~20 anos. Palestrante e Co-fundador do PHPSP. Apaixonado por inovação e resolver problemas complexos de maneiras simples. Pai do Akira <3
3. Caos Agenda 02 O que analisar 01 Por onde começar
4. 03 O que padronizar 04 Como manter Alívio
5. I Final de Semana
6. Problemas 6 Pouca documentação Deploy manual Sem controle do banco de dados Poucas decisões documentadas Onboarding lento Servidores sem padrão
7. Twitter https://twitter.com/vlad_mihalcea/status/1286492891364368384
8. Negócio Jira e Confluence Arquivos/templates para testes Decisões de negócio Funcionalidades do sistema Relatórios e métricas
9. Equipe Cultura justa Post-mortem Criticidade das aplicações Lista de Bugs Decisões documentadas Documentações e fluxos
10. Servidores Acessos Provisionamento Deploy Versões !!!! Logs e monitoramento Backup
11. Backup Banco de dados Configurações de aplicação Arquivos Snapshot / Imagem Recuperação de desastre Validar o backup e tempo de restauração
12. Código Definição de entregue
13. Definição de entregue TASK Branch criado a partir da develop Atende completamente os requisitos do ticket Scripts de alteração de banco validados Deploy executado em Dev com sucesso Requisitos do ticket validados em Dev por quem finalizou Merge Request com mínimo de 02 aprovações Deploy executado em Homologação com sucesso Validado pelo QA no ambiente de Homologação
14. Definição de entregue BUG Branch criado a partir da main Corrige o problema pontualmente Tag criada Deploy em produção Validado em produção Branch sincronizado entre main e develop
15. Código Definição de entregue Commits (conventional-commits)
16. Twitter https://twitter.com/jairhenrique/status/1288521050511335424
17. Commits (conventional-commits) https://www.conventionalcommits.org/pt-br/ <tipo>(<escopo opcional>): <título> <corpo opcional> <rodapé opcional>
18. Commits (conventional-commits) static: alterações no conteúdo de arquivos estáticos (dados .json, imagens, etc) cd: Alterações em nossos arquivos e scripts de configuração para CD docs: somente alterações na documentação feat: um novo recurso fix: uma correção de bug da aplicação improve: alguma alteração de código que melhore o comportamento de um recurso perf: uma alteração de código que melhora o desempenho refactor: uma alteração de código que não corrige um bug nem adiciona um recurso style: alterações que não afetam o significado do código (espaço em branco, formatação, ponto e vírgula, etc) test: Adicionando testes ausentes ou corrigindo testes existentes
19. Código Definição de entregue Merge Request / Code Review Commits (conventional-commits)
20. Merge Request / Code Review Seguir o Conventional Commit Utilizar descrições em PT-BR Descrever o porque foi feita a modificação ou adição de funcionalidade Menos de 300 linhas de alterações, se possível (Sem contar os testes) Gitignore global não do repo Sempre marcar "Remove source branch" Mínimo de 02 aprovações Seguir recomendações de revisão do código Giphy <3
21. Código Definição de entregue Merge Request / Code Review Git workflow Commits (conventional-commits)
22. Git workflow Branch develop recebe os merges do que está sendo produzido Branch homolog recebe os merges vindos somente da branch develop Branch main recebe os merges vindos somente da branch homolog
23. Git workflow TAG 1.2.3 Seguir as definições macro do https://semver.org/lang/pt-BR/ versão Maior - MAJOR quando fizer mudanças incompatíveis na API versão Menor - MINOR quando adicionar/melhorar funcionalidades mantendo compatibilidade versão de Correção - PATCH quando corrigir falhas mantendo compatibilidade
24. Git workflow Release Notes #### Fix * mensagens do conventional commit #### Melhorias * mensagens do conventional commit #### Adicionados * mensagens do conventional commit
26. Código Definição de entregue Merge Request / Code Review Git workflow Ambiente Dev Commits (conventional-commits)
27. Ambiente Dev Docker / Vagrant / Ansible Facilita “subir” o ambiente de desenvolvimento Documenta as dependências do projeto
28. Código Definição de entregue Merge Request / Code Review Git workflow Ambiente Dev Banco de dados (migrations) Commits (conventional-commits)
29. Banco de dados (migrations) Permite deploy automatizado Documentar modificações feita na base (cuidado com índices) Melhora controle de acesso direto ao banco de produção Dica: validar se “algo” existe antes de executar
30. Código Arquivo de configurações
31. Arquivo de configurações JSON / INI / YAML Facilita deploy automatizado Controlar funcionalidades por ambiente Controlar mudanças de IP | ULRs | API | Acessos
32. Código Arquivo de configurações Arquivos de log
33. Twitter https://twitter.com/ericktedeschi/status/1292942398822191105
34. Arquivos de log Definir nível dos logs para cada ambiente Definir folders e tempo de rotação Utilizar “padrões de mercado”
35. Código Arquivo de configurações Arquivos de log Linguagem ubíqua
36. Linguagem ubíqua Documentação para facilitar entendimento de todos (glossário) Feita em conjunto com cliente e área de negócio Utilizar PT-BR sempre que possível
37. Código Arquivo de configurações Arquivos de log Linguagem ubíqua Decisões de arquitetura
38. Decisões de arquitetura Documentar o que foi feito e o cenário atual da aplicação/time/empresa ADR - Palestra Dohms
39. Código Arquivo de configurações Arquivos de log Linguagem ubíqua Decisões de arquitetura Tarefas/Tickets
40. Tarefas/Tickets Modelos http://www.writeafeature.com
43. Tarefas/Tickets Criterios de aceite Recomendações Técnicas Documentação e exemplos de utilização
44. Código Arquivo de configurações Arquivos de log Linguagem ubíqua Decisões de arquitetura Tarefas/Tickets Deploy Contínuo
45. Deploy Contínuo Começar algo, mesmo que simples Pipelines / Actions
46. I Hoje
47. Referências https://eltonminetto.dev/post/2020-06-29-clean-architecture-2anos-depois/ https://thephp.website/br/ https://www.redhat.com/architect/developer-experience https://pt.slideshare.net/augustopascutti/logs-36298518 https://pt.slideshare.net/augustopascutti/errors-89819861 https://gist.github.com/ivanrosolen/dd3fe475d058aca7ca9accf2b7e1d4bd https://gist.github.com/ivanrosolen/b5fc4f281b427949d24e849d982b888b https://help.github.com/en/github/using-git/ignoring-files#create-a-global-gitignore https:/mermaid-js.github.io/mermaid-live-editor/
48. I Dúvidas?