10.6.2.3 Lidando com o Feedback

Na seção anterior, solicitamos a revisão do PR para a conta da camilamaia. Agora, vamos entender como lidar com o feedback recebido e aplicar as sugestões na prática.

A revisão da conta camilamaia foi concluída. Podemos verificar isso tanto na página 5.8.2 Página de Notificações (Notifications), clicando no notificação nova.

Ou, acessando diretamente o Histórico de Ações da 10.4.1 Aba Conversation do PR.

O resultado da revisão foi: ❌ Solicitação de Alterações . Além disso, há um comentário geral sobre o PR que diz:

O PR está ótimo! Amei o gif do pinguim 🐧 Deixei apenas uma sugestão de alteração.

E um comentário contendo a sugestão que diz:

Muitas ferramentas de programação processam arquivos linha por linha e esperam que cada uma termine com uma quebra de linha (\n). Quando isso não ocorre, a última linha pode ser interpretada incorretamente, causando erros ou comportamentos inesperados.

Isso acontece porque muitos sistemas operacionais seguem o padrão Unix, um conjunto de regras e convenções amplamente adotado na computação. O Unix foi criado na década de 1970 e influenciou sistemas como Linux e macOS. Uma dessas convenções é que arquivos de texto devem terminar com uma quebra de linha para garantir compatibilidade com ferramentas que leem arquivos sequencialmente.

Além disso, essa prática é recomendada por diversos editores de código e linters (ferramentas que analisam o código para garantir boas práticas).

Por isso, sugiro adicionar uma linha vazia no final deste arquivo.

Aqui estão algumas referências que explicam isso melhor:

• Por que inserir uma linha em branco no final do código?

• Por que arquivos devem terminar com uma quebra de linha?

Se precisar de mais explicações, é só avisar!

Sugestão de Alteração: A mudança sugerida adiciona uma linha em branco ao final do arquivo README.md. Isso é uma boa prática recomendada por sistemas Unix e ferramentas de análise de código para evitar problemas de compatibilidade. A revisora explicou detalhadamente a importância dessa alteração e forneceu links para referências.

Status do PR: Uma solicitação de alteração pendente. Não há conflitos com a branch base, então o merge poderá ser feito automaticamente.

Vamos começar reagindo ao comentário positivo recebido.

Agora, vamos analisar a sugestão oferecida.

• Entendemos a sugestão? Sim, a motivação e o que precisa ser feito estão bem explicados.

• Concordamos com a sugestão? Sim, parece ser um padrão adotado e que faz sentido.

Sendo assim, vamos aceitar a sugestão. Para isso, clicamos no botão Commit suggestion abaixo da sugestão.

Na caixa de diálogo, preenchemos a mensagem principal com:

Adiciona linha vazia ao final do arquivo README.md

E a mensagem adicional com:

Muitas ferramentas de programação processam arquivos linha por linha e esperam que cada uma termine com uma quebra de linha (\n). Quando isso não ocorre, a última linha pode ser interpretada incorretamente, causando erros ou comportamentos inesperados.
Isso acontece porque muitos sistemas operacionais seguem o padrão Unix, um conjunto de regras e convenções amplamente adotado na computação. O Unix foi criado na década de 1970 e influenciou sistemas como Linux e macOS. Uma dessas convenções é que arquivos de texto devem terminar com uma quebra de linha para garantir compatibilidade com ferramentas que leem arquivos sequencialmente.

Além disso, essa prática é recomendada por diversos editores de código e linters (ferramentas que analisam o código para garantir boas práticas).

Referências:
- https://pt.stackoverflow.com/questions/272449/por-que-inserir-uma-linha-em-branco-no-final-do-c%C3%B3digo
- https://jlozovei.dev/pt-br/blog/why-you-should-put-a-newline-at-the-end-of-your-code/

Clicamos em "Commit changes". Isso cria um commit e já resolve a conversa automaticamente.

A página é atualizada e exibe um painel no topo com a mensagem "Suggestion successfully applied", indicando que a sugestão foi aplicada com sucesso.

Podemos ver também que o novo commit já consta na seção de Histórico de Ações.

E que agora, na 10.4.2 Aba Commits, o novo commit aparece.

Na 10.4.4 Aba Files Changed, onde o comentário com a sugestão estava presente, agora há um painel com a mensagem "aprendizCumbucaDev marked this conversation as resolved", indicando que a conversa foi marcada como resolvida pela conta aprendizCumbucaDev (feito automaticamente ao aceitar a sugestão).

Por fim, re-solicitamos a revisão da conta camilamaia.

E, camilamaia aprova o PR 🎉

Agora, a revisão está completa! Nas próximas seções, vamos aprender como mesclar um PR ao branch principal.