Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

Roadmap to 1.0 #201

Open
4 tasks
perrygeo opened this issue Jul 12, 2017 · 0 comments
Open
4 tasks

Roadmap to 1.0 #201

perrygeo opened this issue Jul 12, 2017 · 0 comments
Labels

Comments

@perrygeo
Copy link
Contributor

perrygeo commented Jul 12, 2017

The purpose of this ticket is to specify the work required for an official 1.0 release.

What does a 1.0 release mean? If we follow the advice of Semantic Versioning:

Version 1.0.0 defines the public API. The way in which the version number is incremented after this release is dependent on this public API and how it changes.

It's also an implicit acknowledgement of completeness. Before releasing 1.0, I'd like to

  • Achieve feature parity with the Mapbox HTTP API as specified by https://www.mapbox.com/api-documentation. This is the biggest lift, see the API support section in the github project.

  • Review the public API. A large part of the contract with a 1.0 release is based on keeping a stable interface. Most development after this point will be adding to the API or changing it in backwards compatible ways, with every effort made to avoid breaking users code. Worth some time to make sure we're 🆗 with the current interface.

  • Open question: what do we need to improve documentation for this project? How we manage and maintain our markdown docs, doctests, sphinx-generated api documentation and the official documentation page is to be determined.

  • Do we want to do a sibling 1.0 release of the CLI?

Thoughts welcome below. Project ➡️ https://github.com/mapbox/mapbox-sdk-py/projects/1

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants