O documento fornece diretrizes para montar uma palestra técnica eficaz, incluindo documentar código e histórico de commits, limpar código, escrever testes claros e revisar merge requests de forma construtiva. Apresenta ferramentas como Tomdoc para documentação, Keepachangelog para gems e commits atômicos para contar a história do código.

1. Como montar uma palestra
com seu conhecimento dos
últimos meses
Fabio Perrella
Lider Técnico
Hospedagem

3. http://www.greaterthancode.com/podcast/008-sandi-metz-and-katrina-owen/

4. 2017
2016

5. https://github.com/fabioperrella/my-changelog/blob/master/CHANGELOG.md

7. Deixando o código mais
amigável para as próximas
gerações
Fabio Perrella
Lider Técnico
Hospedagem

8. Agenda
- Documentação
- Histórico de commits
- Limpeza do código
- Testes claros
- Merge requests construtivos

9. Tomdoc - tomdoc.org
Documentação de métodos

11. asciiflow.com

13. Documente códigos sem contexto

15. Utilize o corpo do commit para mais detalhes

16. Keepachangelog.com
Documentação de gems
- Ajuda muito na hora de precisar atualizar de uma versão X para Y

17. http://code.locaweb.com.br/paas/provisioning-core/blob/master/CHANGELOG.md

18. Documente tudo que possa gerar dúvidas

19. Exemplo no crontab

20. Contando a história do código através dos commits
https://about.futurelearn.com/blog/telling-stories-with-your-git-history/

21. Commits atômicos

22. Explicar o porquê e não só o “como”
http://chris.beams.io/posts/git-commit

23. Remover commits de wip, typo, fix, etc..
$ git rebase -i master (usando squash)

24. Preferir rebase para atualizar feature branches
Merge só quando for mergear o MR

25. Commit --fixup para atualizar commit antigo
https://robots.thoughtbot.com/autosquashing-git-commits

26. git add .
git commit --fixup add92db

27. git rebase -i --autosquash HEAD~6

28. Limpeza de código

29. Module prepend
http://gshutler.com/2013/04/ruby-2-module-prepend/

33. Module prepend
Vantagens sobre a gem aspector:
- fica explícito no código!
- aparece no stacktrace explicitamente em caso de exceção

34. Mais clareza com keyword arguments
http://gshutler.com/2013/04/ruby-2-module-prepend/

36. Uso de funções (métodos) para iterators

39. Prefira composição do que herança

40. Remoção de código obsoleto
gem debride
https://github.com/seattlerb/debride

42. Testes mais claros
Testes também servem como documentação!

44. Proposta

45. Proposta
- Não se importe muito com DRY. Caso se importe, prefira uso de métodos
- Evite o uso de LETs e BEFOREs
- Tudo bem colocar mais de 1 expect dentro dos ITs
- Separe em 3 blocos: setup, exercise e verify
http://blog.locaweb.com.br/geral/melhorando-o-entendimento-de-testes-com-rspec

46. Merge requests construtivos
- Torna o código mais entendível
- Reduz chance de bugs
- Espalha conhecimento entre membros
- Serve de referência para futuras consultas
Guideline de hospedagem:
apps-hospedagem.docs.arda.locaweb.com.br/guidelines/merge-requests.html

47. Exemplo
https://code.locaweb.com.br/paas/hodor/merge_requests/267

49. Dúvidas?
@fabioperrella