Maintain consistency in API design, documentation, and implementation across all supported platforms to improve developer experience and reduce friction.
Maintain consistency in API design, documentation, and implementation across all supported platforms to improve developer experience and reduce friction.
API Documentation Standards:
initialize
, de_initialize
, not initialize, de_initializeCross-Platform Implementation:
Example: Cross-platform implementation Instead of:
// Adding feature only for Android
// platform/android/CHANGELOG.md
* Add support for the [`slice` expression](https://maplibre.org/maplibre-style-spec/expressions/#slice) ([#1113](https://github.com/maplibre/maplibre-native/pull/1133))
Prefer:
// Implementing across platforms
// CHANGELOG.md
* Add support for the [`slice` expression](https://maplibre.org/maplibre-style-spec/expressions/#slice) across all platforms ([#1133](https://github.com/maplibre/maplibre-native/pull/1133))
Following these practices ensures that developers have a consistent experience regardless of which platform they are using and reduces confusion when working with MapLibre Native APIs.
Enter the URL of a public GitHub repository