- Use esse template para o
README.mddo projeto. - Para projetos com mais de um repositório direcionar para os seus arquivos de
README.md. - Manter o
README.mdatualizado à medida que o projeto evolui. - Comentar pequenas porções de código quando achar que o código não é autoexplicativo.
- Comentar o código quando pertencer a uma biblioteca de funções que pode ser utilizada por múltiplos projetos.
- Manter os comentários de código atualizados à medida que o código evolui.