mapbox / mapbox/vector-tile

Deprecate v1.x / merge 2.x into master

Open
#46 4 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
52
Forks
33
PR merge metrics
No merged PRs in 30d

Description

Currently the only (known) application depending on the v1 version of this library is MBGL. Once MBGL moves to vtzero (https://github.com/mapbox/mapbox-gl-native/pull/11489) I propose we move forward with v2.x here by:

- [ ] merging v2.x branch (https://github.com/mapbox/vector-tile/tree/2.x) into master
- [ ] adding a deprecation note in the readme that using v1.x is no longer recommended for us
- [ ] adding a section of the readme that describes when you'd use vtzero vs mapbox/vector-tile
- [ ] consider renaming this repo to `mapbox/libvectortile` since `mapbox/vector-tile` is so easily confused given its generic name

Sound like a good plan? @flippmoke @kkaefer @anandthakker @joto

Context: v1.x of this library was never well tested. Vtzero is extremely well tested. The v2.x branch is now based on top of vtzero and is therefore a higher level, more robust replacement.

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 reviewing the 2.x branch, master, and the linked MBGL migration context to determine whether the proposed merge is still appropriate. Then resolve the checklist decisions: merging 2.x, documenting v1.x deprecation and vtzero versus mapbox/vector-tile usage in the README, and considering the repository rename; done means the agreed plan is completed and documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
data
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.