Zh-hans:Good changeset comments

From OpenStreetMap Wiki
Jump to navigation Jump to search


为什么要为变更集注释?

需要使用变更集注释描述更改的原因有很多:

  • 出于对地图绘制者的礼貌, 这让别人更容易理解你做了什么变更、以及为什么要这么做。请不要对大家共同维护的项目使用诸如“我做了什么与你无关”的注释!
  • 出现失误可以迅速修正 – 如果有一个删除了50个餐馆的变更集注释为“根据Bing绘制了几座房子”,那么很明显这是个错误。而如果注释为“删除上周时调查发现已经关闭的餐馆”则说明你确实有充分理由删掉这些餐馆。
  • 提高编辑的可信度,通过解释为什么要做这个变更来避免编辑战。如果你添加了一个从卫星图上看不清的建筑,别人可能将其删除,但如果为变更集标明“添加了新建的建筑”,那么别人在尝试删除时就会三思。
  • 作为备忘录。变更集注释可以帮助你了解什么时候为什么做了什么变更。如果半年后需要查询某个变更集中的信息,不标明的话很难找到是哪个变更集。

一些绘制者还会用变更集注释来记录他们*尚未完成*的事情(“…这里需要更详细的信息”、“…河流西边的区域仍然缺失”等等)。

There are situations where it is evident what a changeset is about – especially if it affects only a single object – but these situations are less common than you might think. If you have fixed a typo, a changeset comment of "fixed typo" still makes it clear that this was indeed what you intended, rather than your cat playing with the keyboard again!


应该怎样写变更集注释?

一个好的变更集注释应当可以简洁而明确地描述所做的编辑。至少应包括一个动作(怎样修改)和一个对象(改了什么)并且可以通过列出编辑的地方和使用的信息来源来进一步补充。

请将变更集注释的重点放在地图编辑上,避免此类注释:

  • 你的联系方式,例如你的电子邮箱、电话
  • 你的目的,例如“帮助更多人”

你的个人资料("https://openstreetmap.org/user/<your_user_name>")中提供了这些信息,点击你的用户名就可以看到你的信息、介绍等。

示例

优秀的变更集注释示例:

  • "Added buildings in industrial area."
  • "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"
    • English: "Cologne: Removed junction=roundabout from non-roundabouts, traffic sign 215 not present"
  • "added a few tidal inlets to the coastline of Maranhão"
  • "Added houses and house numbers based on Bing and local knowledge. Some house numbers could sadly not be found."

无用的变更集注释示例:

  • "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"
  • "some fixes"
  • "fix"
  • "additions to map"
  • "#hotosm-project-1234 #MissingMaps #Country #redcross"
  • "--"
  • "asdf"
  • "United States"

请记住,只要项目存在,你的变更集注释将一直保留在数据库中;不要用它们来发泄对软件或是对提示你修复错误、质疑你的信息来源绘制者的愤怒。

添加到现有变更集时的注意事项

尝试将变更集保持在一个可控的大小,无论是变更的数量还是地理范围。

不同编辑器的行为:

  • iD 每次上传时都会创建新的变更集。 → 此章节与iD无关.
  • Potlatch (version 1 and 2) 默认情况下,将编辑附加到现有变更集,但可以按“C”关闭当前变更集。
  • JOSM 默认每次上传时创建新的变更集,但可以在上传页面更改设置。

上传变更集并指定变更集注释时,某些编辑器(具有某些设置)并不总是立即关闭变更集,后续编辑可能会添加到同一变更集,因此共享同一变更集注释。

如果您已经完成了一个编辑工作,并且开始在其他编辑,请确保将“其他地方”的编辑记录在一个单独的变更集中,并带有相应的变更集注释。

复用以前的注释

大多数编辑器都允许您通过在下拉框中显示以前的注释或自动填充上一次的注释来复用旧注释。这有时可能是有道理的,但不要落入“方便陷阱”,即使用过于通用的注释(例如“进行了某些修复”),这样您就可以在所有编辑中重复使用它们。这使得评论毫无价值。并且注意不要使用与您的编辑不匹配的旧注释。

JOSM 默认情况下自动填充上一个变更集的注释。这可能会导致意外地重复使用旧的(或是错误的)注释。可以禁用自动填充:how to.

标签

一些用户已经开始在变更集注释中使用“hashtags”。由于hashtag通常是针对机器的,而不是针对人的,所以对于hashtag是否属于“好的变更集注释”存在一些争论,还没有得到广泛的认同。OpenStreetMap允许向变更集添加其他标记,用于机器阅读的关键字单独进行标记(如使用"keywords"或"hashtags")更合适。从2017年8月起,iD编辑器支持一个单独的“hashtags”字段和变更集上传。尽管如此,一些工具将用hashtag预先填充变更集注释,同时其他工具会使用这些注释,甚至依赖它们来分析、可视化变更集。Hashtags只是带有hash(#)前缀的自由格式文本字段。它们可以作为可读的注释与手动编写的文本一起使用,也可以散布在其中,当然,一个好的变更集注释应该做到这一点,而不是包含预填充的文本。

如果有人不使用好的变更集注释该怎么办?

友好地请他们这样做!

如果对另一个用户的变更集发表评论,请始终保持礼貌

Hello $mapper

or

Hello $mapper and welcome to OpenStreetMap!

☝️如果是新用户


如果他们使用了简短或无用的注释,如“.”,可以在变更集注释中讨论:

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

如果他们和你用同一种语言,那么很明显他们会用这种语言写讨论;如果他们不这样做,那么就使用Google/Microsoft/Deepl等在线翻译工具将其翻译成他们的语言。

搜索变更集注释

  • OSMCha - 需要登录,前往 'Filters' 添加字符串并应用。
  • tbc

另见