You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.
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
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?
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:
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
The text was updated successfully, but these errors were encountered: