Pt:Good changeset comments

From OpenStreetMap Wiki
Jump to navigation Jump to search

Porque devo usar comentários em changesets?

Existem várias razões para usar um comentário para descrever uma edição tua:

  • Como cortesia para com outros editores, pois torna mais fácil perceber o que foi feito e porquê. Ao não usar um comentário dá o ar de que "não tens nada a ver com isso", que não se encaixa bem com um projecto onde estamos todos a trabalhar na mesma coisa!
  • Para evitar mal-entendidos e corrigir erros rapidamente – se uma edição com o comentário "adicionei algumas casa pela Bing" apaga 50 restaurantes é óbvio que se trata de um erro. Por outro lado, uma edição com o comentário "apaguei restaurantes que estavam fechados durante a sondagem da semana passada" deixa claro que a intenção era apagar os restaurantes.
  • Para valorizar as tuas edições e prevenir guerras de edições ao explicares porque fizeste algo e quais foram as tuas fontes. Se alguém vê uma casa que adicionaste mas que não está visível nas suas imagens aérias podem ser levados a apagá-la. Se o comentário disser "adicionei casa construida recentemente" vão pensar duas vezes!
  • Para refrescar a memória. Comentários ajudam a relembrar o que fizeste, porquê e quando. Podem passar 6 meses ou 1 ano até quereres a informação dos comentários, e é difícil prever por que haverás de precisar de encontrar uma edição antiga.

Alguns editores também usam os comentários para guardar coisas que não fizeram, ou ainda não fizeram ("… mas ainda precisa de uns ajustes", "… mas a área a oeste do rio ainda está em falta" etc).

Há situações em que é óbvio o que foi feito num changeset - especialmente se afecta um único objecto - mas tais situações são menos comuns do que possas imaginar. Se corrigiste um pequeno erro ortográfico, um comentário "corrigir erro ortográfico" deixa claro que era aquela a tua intenção, an invés do teu gato a brincar com o teclado outra vez!

Como escrever comentários em changesets?

Um bom comentário deverá descrever a edição de forma concisa e adequada. No mínimo, deverá incluir um verbo (como mudaste as coisas) e um objecto (o que mudaste), e pode ser melhorado ao listar que lugares foram editados e quais foram as fontes usadas.

Foca os comentários no que foi alterado no mapa. Evita comentários como os teus contactos (por exemplo, endereço de email), ou boas intenções (por exemplo, "para ajudar pessoas").

Para este propósito, a descrição no teu perfil de utilizador em "https://openstreetmap.org/user/<nome_de_utilizador>" é o lugar certo. Ao clicar no teu nome de utilizador, outros utilizadores podem ver quem és, quais as tuas motivações, e a tua introdução.

Exemplos

Exemplos de bons comentários incluem:

  • "Adicionar edifícios em área industrial"
  • "Adicionar um caminho pedestre a ligar Donnington Close a Roman Way baseado em conhecimento local"
  • "Actualizar moradas pelo INE"
  • "Actualizar fronteiras do Parque Nacional da Peneda-Gerês"
  • "Adicionar estradas e ciclovias a SE de Newport"
  • "Adicionar casas e números de porta baseado no Bing e conhecimento local. Infelizmente não foi possível encontrar alguns números."

Alguns comentários são inúteis e não trazem nenhum dos possíveis benefícios. Alguns exemplos:

  • "BBOX:3.23,41.96,3.23,41.96 ADD:14 UPD:0 DEL:0"
  • "151005-DE-FUe"
  • "Edição enviada via ArcGIS Editor para o OpenStreetMap dec20 às 1/13/2012 9:56:00 AM"
  • "algumas correcções"
  • "correcção"
  • "adições ao mapa"
  • "#hotosm-project-1234 #MissingMaps #Country #redcross"
  • "--"
  • "asdf"
  • "Estados Unidos"

Lembra-te que os teus comentários serão guardados na base de dados enquanto o projeto viver. Não os uses para libertar a tua fúria em programas ou outros editores que te podem ter pedido para corrigir algo, ou podem ter questionado as tuas fontes.

Cuidado ao adicionar a um changeset existente

Tenta manter changesets num tamanho aceitável, tanto em número de mudanças como na área geográfica.

Quando fazes upload de um changeset e escreves uma descrição, alguns editores, com certas configurações, nem sempre fecham o changeset de imediato. Assim, edições subsequentes podem ser adicionadas ao mesmo changeset e portanto partilhar o mesmo comentário.

Se acabaste um conjunto de mudanças e estás a começar algo diferente, faz por guardar estas novas mudanças num novo changeset, com o seu próprio comentário apropriado.

Comportamentos de diferentes editores:

  • iD cria um novo changeset em cada upload. → Esta secção não é relevante para o iD.
  • Potlatch (versões 1 e 2) por defeito, adiciona edições a um changeset já existente, mas podes carregar em "C" para fechar o changeset actual.
  • JOSM por defeito, cria um novo changeset em cada upload, mas é possível alterar essa configuração no menu de upload.

Reutilizar comentários antigos

Grande parte dos editores permitem reutilizar comentários antigos. Isto pode, por vezes, fazer sentido, mas não caias na armadilha da conveniência ao usar comentários demasiado genéricos (por exemplo, "algumas correcções") só para os poderes reutilizar em edições futuras. Isto torna os comentários inúteis. Tem cuidado para não reutilizares um comentário antigo que não se encaixa com as edições feitas.

Por defeito, o JOSM preenche automaticamente a caixa de comentário com o último comentário usado, se tiver menos de 4 horas, o que pode levar a reutilizar um comentário antigo (e errado) acidentalmente. É possível desactivar esta funcionalidade completamente..

Hashtags

Alguns utilizadores começaram a usar "hashtags" em comentários. Como hashtags são principalmente viradas para máquinas e não humanos, houve algum debate sobre hashtags pertencerem ou não em "bons comentários", e não existe um consenso. O OpenStreetMap permite adicionar outras etiquetas aos changesets, e palavras-chave para máquinas estariam melhor no seu próprio tag, como "keywords" ou "hashtags". A partir de Agosto de 2017, o editor iD suporta um campo "hashtags" em changesets. Apesar disso, algumas ferramentas ainda populam os comentários com hashtags, e outras usam, e até dependem, da sua presença para analisar e visualizar changesets.

O que fazer se alguem não escreve bons comentários?

Pede educadamente que o façam!

Se estás a comentar num changeset de outro utilizador, tenta sempre ser educado:

Hello $mapper

Ou, se forem novos utilizadores:

Hello $mapper and welcome to OpenStreetMap!

Se têm usado comentários demasiadamente curtos ou inúteis, como por exemplo ".", podes adicionar o seguinte à sugestão acima:

Also, please do use meaningful changeset comments - "." does not help other mappers understand what you are doing.

Se são faladores da mesma linguagem que tu, escreve nessa linguagem. Caso contrário, usa um tradutor online, como o Google, Microsoft, ou Deepl, para traduzir a mensagem na sua linguagem.

Procurar por comentários de changesets

Faz login no OSMCha, vai aos 'Filtros', adiciona um comentário e clica em 'aplicar'.

Ver também

O texto desta página é a tradução do artigo original em inglês, conferida pra rev2434242.