RU:Good changeset comments

From OpenStreetMap Wiki
Jump to navigation Jump to search
  • Good changeset comments
  • In other languages

Что такое комментарий к пакету правок?

Пакет правок — это набор изменений, сделанных одним пользователем за относительно небольшой отрезок времени.

Когда вы загружаете правки на сервер, программа редактирования предложит вам ввести описание пакета правок.

Диалоговые окна некоторых редакторов:

Комментарий, который вы вводите, будет отображаться вместе с вашими правками во многих случаях, например, когда кто-нибудь изучает историю объекта или смотрит список всех правок в области.

xkcd иллютрирует типичную проблему с комментариями

Если вы знакомы с git, то комментарии к пакетам правок аналогичны git commit message по правилам написания, целям и назначению. Сами же пакеты правок (changeset) аналогичны коммитам.

Зачем мне писать комментарии к правкам?

Есть множество причин, почему вы должны сделать комментарий к своей правке для описания внесенных изменений:

  • Из вежливости к вашим коллегам-картографам, ведь этот комментарий помогает им легче понять что вы сделали и почему. Если вы не оставляете комментарий к правкам, то это выглядит как "Это не твоё дело, что я тут сделал и почему" что явно не очень хорошо вписывается в проект где все работают сообща.
  • Во избежание недоразумений и быстрого исправления ошибок. Если правка с комментарием "Обвёл пару домиков по Bing" удаляет 50 ресторанов, то очевидно, что это ошибка. Если бы комметарий был вроде "Удаляю закрывшиеся рестораны которые я встретил прогуливаясь на прошлой неделе", то всем было бы сразу ясно, зачем удалили эти рестораны и почему.
  • Увеличить ценность ваших правок и предотвратить войну правок показав почему вы сделали правку и на основании каких источников. Если кто-то обнаружит, что вы добавили дом, который совершенно не видно на спутниковом снимке, то захочет удалить его. Но, взглянув на комментарий "Добавил недавно возведённый дом", он передумает.
  • В качестве памятки. Комментарии помогут вам в будущем вспомнить что вы делали, почему и зачем. Попробуйте через 6 месяцев или год вспомнить эту информацию :)

Некоторые картографы также используют комментарии, чтобы показачть, что они пока ещё не завершили работу. ("… но надо ещё доработать …", "… но область к западу от реки пока отсутствует …" и тому подобное)

Бывают ситуации, когда назначение пакета правок очевидно — особенно если он затрагивает только один объект. Но так бывает сильно реже, чем может показаться. Если вы поправили опечатку, комментарий "Поправил опечатку" всё ещё помогает прояснить, что вы реально хотели исправить опечатку, а не пустили кота походить по клавиатуре.

Примеры

Как надо делать

Хороший комментарий должен кратко и адекватно описывать правку.

Примеры хороших комментариев:

  • "Проезд был неровно обозначен"
  • "Добавление деревьев"
  • "Здания в индустриальной зоне"
  • "Добавление адресов домов на Московской улице"
  • "Инфраструктура школы не была обозначена"
  • "Добавление отсутствующих домов в поселке Васюки"
  • "Добавил дома и номера домов, основываясь на данных Bing и на знании местности. Некоторые номера домов, к сожалению, не удалось найти".
  • "Добавление отсутствующих троп по Strava Heatmap"

Также можно посмотреть на примеры английских комментариев:

  • "Add a footpath link from Donnington Close to Roman Way based on local knowledge"
  • "Updating Danish street addresses from OSAK (AWS): Bag Hegnet"
  • "Updated Algonquin Park boundary"
  • "Add country roads and cycleway SE of Newport"
  • "Köln: Nicht-Kreisverkehre, 'junction=roundabout' entfernt, Vz 215 nicht vorhanden" (German for "Cologne: Removed junction=roundabout from non-roundabouts, traffic sign 215 not present")
  • "added a few tidal inlets to the coastline of Maranhão"

Как не стоит делать

Некоторые комментарии бесполезны и не приносят пользы. Вот некоторые реальные плохие примеры (которые встречаются чаще, чем хотелось бы):

  • "Добавил новые объекты"
  • "разные исправления"
  • "Новая информация"
  • "актуализация"
  • "(no comment)"
  • "фиксы"
  • "улучшения карты"
  • "Россия"
  • "фывдлаеы"
  • "--"

Больше плохих примеров не информативных комментариев можно посмотреть тут.

Следующие примеры, возможно, были сгенерированы автоматически, и хотя они как будто и передают некоторую информацию, на самом деле они не описывают ничего полезного о том, «что» и «почему» меняется:

  • "BBOX:3.23,41.96,3.23,41.96 ADD:14 UPD:0 DEL:0"
  • "151005-DE-FUe"
  • "Edit uploaded via ArcGIS Editor for OpenStreetMap feature service dec20 at 1/13/2012 9:56:00 AM"

Так же помните, что ваши комментарии будут жить в базе столько, сколько будет жить проект. Поэтому не стоит в них выражать свою злость, гнев, недовольство редакторами или вашими коллегами-картографами.

Будьте осторожны, дополняя открытый пакет правок

Поведение редакторов:

  • iD создаёт новый пакет правок для каждой отгрузки. → Эта секция не относится к iD.
  • Potlatch (версии 1 и 2) дописывает ваши правки в существующий пакет правок по умолчанию, но вы можете нажать C чтобы закрыть текущий пакет правок (changeset).
  • JOSM по умолчанию создаёт новый пакет правок для каждой отгрузки, но вы можете изменить эту настройку в диалоге отгрузки (upload).

Когда вы отгружаете ваши правки на сервер и указываете комментарий, некоторые редакторы (с некоторыми настройками) не всегда закрывают пакет правок. Таким образом, несколько правок могут быть объеденены в общий пакет с едиными комментарием.

Если вы завершили определённую задачу и приступили к другой, удостоверьтесь, что эта другая задача будет сохранена как отдельный пакет правок с отдельным комментарием.

Повторное использование комментариев

Большинство редакторов разрешают переиспользовать предыдущий комментарий (показывая его в выпадающем меню). Это иногда имеет смысл, но не попадайтесь в "ловушку удобства", используя слишком общие комментарии ("немного правок") только для того, чтобы переиспользовать его при следующей отгрузке. Это делает комментарии бесполезными. Также обратите внимание и случайно не используйте старый комментарий к новому пакету правок.

Что делать если кто-то не пишет хорошие комментарии к правкам?

Напишите комментарий автору в наборе правок

И просто вежливо попросите их исправиться! Например можно написать такое сообщение в комментарии к их набору изменений, если комментарии это "--":

Добрый день <username> + и добро пожаловать OpenStreetMap! (если они недавно в OSM)
Пожалуйста в будущем оставляйте комментарии в вашим правкам говорящие о том что было сделано вместо "--", тк это помогает другим понять что вы изменяете.
Подробнее - https://wiki.openstreetmap.org/wiki/RU:Good_changeset_comments
Спасибо!

Конечно, если они говорят на другом языке от вашего, можете написать на английском или использовать переводчики (Google Translate / DeepL) для перевода на их язык.

Если пользователь продолжает не оставлять полезных комментариев

Можно снова вежливо написать в тот же набор правок с вопросом, видел ли пользователь ваше сообщение о необходимости оставления комментариев.

В случае если на сообщение долгое время нет ответа, а пользователь продолжает делать изменения без осмысленных комментариев - можно через его профиль отправить жалобу (report) модераторам OSM, чтобы они взглянули на ситуацию и или же сами написали про необходимость это делать, или в некоторых случаях поставили пользователя в непродолжительный блок, чтобы он понял, что надо вносить правки по другому.

Смотрите также

  • Key:comment - как комментарии к пакетам правок хранятся в базе данных;
  • Template:UserAppreciatesGoodChangesetComments - чтобы использовать шаблон «пользователь любит хорошие комментарии к пакетам правок», добавьте {{UserAppreciatesGoodChangesetComments}} на свою страницу пользователя в вики.
Retrieved from "https://wiki.openstreetmap.org/w/index.php?title=RU:Good_changeset_comments&oldid=2853075"