mapbox / mapbox/vector-tile-spec

"tags" ⇢ "properties"

Open
#63 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.0 Specification
Dominant language
No language data
Stars
1k
Forks
213
PR merge metrics
No merged PRs in 30d

Description

The specification and protocol buffer definition should use the term "properties", not "tags". "Tags" is OSM-specific nomenclature; "properties" is much more common in the Geo world.

In fact, our own principal libraries for vector tiles prefer "properties":
- [mapnik-vector-tile](https://github.com/mapbox/mapnik-vector-tile/search?utf8=%E2%9C%93&q=property&type=Code)
- [vector-tile-js](https://github.com/mapbox/vector-tile-js#properties-2)

I'm open to this being closed as woulda-coulda-shoulda but too painful to change, if that's the case. It's not a huge deal, I just wanted to invite some discussion.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating every occurrence of "tags" in the specification and protocol buffer definition, then compare the terminology used by the linked mapnik-vector-tile and vector-tile-js libraries. Done means the affected specification and definition consistently use "properties" and the compatibility impact of the rename has been assessed.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.