- Procure por erros de português (gramática, sintaxe e semântica).
- Para tarefas/componentes descreva com clareza os dados de entrada e saída.
- Para tarefas/componentes descreva as principais etapas e exiba as tabelas, gráficos etc
- Use imagens e vídeos sempre que possível.
- Título (1a linha do commit): apresentar resumo do que foi alterado/adicionado/removido. ex: adiciona tutorial da tarefa classificador random forest; adiciona screenshot da matriz de confusão;
- Descrição (outras linhas): dar mais detalhes de cada alteração:
- motivos das alterações ex: tarefa foi modificada para corrigir um bug...; havia um link quebrado no tutorial...; nova tarefa que faz isso foi adicionada...;
- links úteis ex: link para a tarefa em https://github.com/platiagro/tasks/tree/main/tasks/automl-classifier
- Mensagens auto-explicativas! Quem revisa o código deve entender o que foi feito (e porque foi feito) sem perguntar para quem fez o commit.
- Não devem ter conflitos. Solicitar que sejam resolvidas as ocorrências de "This branch has conflicts that must be resolved".