chore: update documentation (#422)

CODE_OF_CONDUCT.md

@@ -1,4 +1,6 @@
 # Contributor Covenant
+
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/maplibre/maplibre/blob/main/CODE_OF_CONDUCT.md)
 
-Please refer to the link on the badge to learn about the code of conduct of this repository.
+Please refer to the link on the badge to learn about the code of conduct of this
+repository.

CONTRIBUTING.md

@@ -1,10 +1,19 @@
 # Contributing
 
-We welcome contributions to this repository. Please follow these steps if you're interested in making contributions:
+We welcome contributions to this repository. Please follow these steps if you're
+interested in making contributions:
 
-1. Please familiarize yourself with the [process of running the example app](https://github.com/maplibre/flutter-maplibre-gl#running-the-example-app).
-2. Ensure that existing [pull requests](https://github.com/maplibre/flutter-maplibre-gl/pulls) and [issues](https://github.com/maplibre/flutter-maplibre-gl/issues) don’t already cover your contribution or question.
-
-3. Create a new branch that will contain your contributed code. Along with your contribution you should also adapt the example app to showcase any new features or APIs you have developed. This also makes testing your contribution much easier. Eventually create a pull request once you're done making changes.
-
-4. If there are any changes that developers should be aware of, please update the [changelog](https://github.com/maplibre/flutter-maplibre-gl/blob/master/CHANGELOG.md) once your pull request has been merged to the `master` branch.
+1. Please familiarize yourself with
+   the [process of running the example app](https://github.com/maplibre/flutter-maplibre-gl#running-the-example-app).
+2. Ensure that
+   existing [pull requests](https://github.com/maplibre/flutter-maplibre-gl/pulls)
+   and [issues](https://github.com/maplibre/flutter-maplibre-gl/issues) don’t
+   already cover your contribution or question.
+3. Create a new branch that will contain your contributed code. Along with your
+   contribution you should also adapt the example app to showcase any new
+   features or APIs you have developed. This also makes testing your
+   contribution much easier. Eventually create a pull request once you're done
+   making changes.
+4. If there are any changes that developers should be aware of, please update
+   the [changelog](https://github.com/maplibre/flutter-maplibre-gl/blob/master/CHANGELOG.md)
+   once your pull request has been merged to the `main` branch.

RELEASE.md

@@ -3,44 +3,72 @@
 This document describes the steps needed to make a release:
 
 ## **On the main branch:**
-1. Update the top-level `CHANGELOG.md` with the commits/PRs since the previous release (the changelogs for the other two packages link there). Ideally at least PRs with breaking changes should already have modified the changelog to list their breaking change.
+
+1. Update the top-level `CHANGELOG.md` with the commits/PRs since the previous
+   release (the changelogs for the other two packages link there). Ideally at
+   least PRs with breaking changes should already have modified the changelog to
+   list their breaking change.
 
 2. Update the library version in `pubspec.yaml` for each supported library:
     - `maplibre_gl_platform_interface`
     - `maplibre_gl_web`
     - `flutter-maplibre-gl`
 
 ### Version numbering
- As long as we are on major version 0 (i.e. version number 0.xx.xx), we increase the minor component (e.g. from 0.16.0 to 0.17.0) for every breaking/significant release. 
 
-We may want to make releases where we only increase the patch version (the final digits) for small bug-fix-releases or similar.
+As long as we are on major version 0 (i.e. version number 0.xx.xx), we increase
+the minor component (e.g. from 0.16.0 to 0.17.0) for every breaking/significant
+release.
 
+We may want to make releases where we only increase the patch version (the final
+digits) for small bug-fix-releases or similar.
 
+## Only on the GitHub release branch
 
-## Only on the GitHub release branch 
-1. After performing the above changes on the main branch (new changelog and versions), create a new git release branch from the main branch, named like `git-release-x.y.z`.
+1. After performing the above changes on the main branch (new changelog and
+   versions), create a new git release branch from the main branch, named
+   like `git-release-x.y.z`.
 
 2. On that branch:
-
-    a.     In `flutter-maplibre-gl` and `maplibre_gl_web` in their respective pubspec.yaml file,  change the `ref` value for the maplibre git dependencies from `main` to `git-release-x.y.z` (the new git release branch).
-
-    b.     In the example app's pubspec.yaml: change the git refs for `maplibre_gl_platform_interface` and `maplibre_gl_platform_interface` to the new git release branch and comment out the `dependency_overrides`. Then the example app will use the packages from this git release branch, instead of their local copies. This way, inter-package dependencies can be tested and users can see how to correctly use the release in their app.
 
-4. Then, create a GitHub release (`x.y.z`) with a new git tag (`x.y.z`) from this git release branch (This can be done from the GitHub web interface).
+   a. In `flutter-maplibre-gl` and `maplibre_gl_web` in their respective
+   pubspec.yaml file, change the `ref` value for the maplibre git dependencies
+   from `main` to `git-release-x.y.z` (the new git release branch).
+
+   b. In the example app's pubspec.yaml: change the git refs
+   for `maplibre_gl_platform_interface` and `maplibre_gl_platform_interface` to
+   the new git release branch and comment out the `dependency_overrides`. Then
+   the example app will use the packages from this git release branch, instead
+   of their local copies. This way, inter-package dependencies can be tested and
+   users can see how to correctly use the release in their app.
+
+4. Then, create a GitHub release (`x.y.z`) with a new git tag (`x.y.z`) from
+   this git release branch (This can be done from the GitHub web interface).
 
 ## Only on the pub release branch
-1. After performing the above changes on the git release branch, create a new pub release branch from the git release branch, named like `pub-release-x.y.z`.
+
+1. After performing the above changes on the git release branch, create a new
+   pub release branch from the git release branch, named
+   like `pub-release-x.y.z`.
 
 2. On that branch:
-
-    a. In `flutter-maplibre-gl` and `maplibre_gl_web` in their pubspec.yaml files change the maplibre git dependencies to hosted dependencies (regular pub.dev dependencies) with the same version number.
-
-    b. In the example apps's pubspec.yaml file, change the `maplibre_gl_platform_interface` and `maplibre_gl_platform_interface` dependencies to use the hosted versions from pub.dev as well.
-
- ### Publishing order to pub.dev
- Then the 3 plugins can be published from this pub release branch in this order (because of the inter-package dependencies):
- 1. `maplibre_gl_platform_interface`
- 2. `maplibre_gl_web`
- 3. `flutter-maplibre-gl`
-
-(For the first two, of course only publish the contents of the relevant subfolder with the same name)
+
+   a. In `flutter-maplibre-gl` and `maplibre_gl_web` in their pubspec.yaml files
+   change the maplibre git dependencies to hosted dependencies (regular pub.dev
+   dependencies) with the same version number.
+
+   b. In the example apps's pubspec.yaml file, change
+   the `maplibre_gl_platform_interface` and `maplibre_gl_platform_interface`
+   dependencies to use the hosted versions from pub.dev as well.
+
+### Publishing order to pub.dev
+
+Then the 3 plugins can be published from this pub release branch in this order (
+because of the inter-package dependencies):
+
+1. `maplibre_gl_platform_interface`
+2. `maplibre_gl_web`
+3. `flutter-maplibre-gl`
+
+(For the first two, of course only publish the contents of the relevant
+subfolder with the same name)

maplibre_gl_platform_interface/CHANGELOG.md

@@ -11,41 +11,74 @@ see top-level CHANGELOG.md
 see top-level CHANGELOG.md
 
 ## 0.14.0, Oct 14, 2021
+
 ### Breaking changes:
-* Replace example styles [#25](https://github.com/m0nac0/flutter-maplibre-gl/pull/25) (also see [#21](https://github.com/m0nac0/flutter-maplibre-gl/issues/21))
-  * The built-in constants for specific styles were  removed. You can continue using these styles by using the styles' URL
 
+* Replace example
+  styles [#25](https://github.com/m0nac0/flutter-maplibre-gl/pull/25) (also
+  see [#21](https://github.com/m0nac0/flutter-maplibre-gl/issues/21))
+    * The built-in constants for specific styles were removed. You can continue
+      using these styles by using the styles' URL
 
 ## 0.13.0, Oct 6, 2021
-🎉 The first release of flutter-maplibre-gl with the complete transition to Maplibre libraries. 🎉
+
+🎉 The first release of flutter-maplibre-gl with the complete transition to
+Maplibre libraries. 🎉
 
 ### Changes cherry-picked/ported from tobrun/flutter-mapbox-gl:0.12.0
-* Batch creation/removal for circles, fills and lines [#576](https://github.com/tobrun/flutter-mapbox-gl/pull/576)
+
+* Batch creation/removal for circles, fills and
+  lines [#576](https://github.com/tobrun/flutter-mapbox-gl/pull/576)
+
 ### Changes cherry-picked/ported from tobrun/flutter-mapbox-gl:0.11.0
-* Add batch mode of screen locations [#554](https://github.com/tobrun/flutter-mapbox-gl/pull/554)
+
+* Add batch mode of screen
+  locations [#554](https://github.com/tobrun/flutter-mapbox-gl/pull/554)
 
 ## Below is the original changelog of the tobrun/flutter-mapbox-gl project, before the fork.
 
 ## 0.10.0, February 12, 2020
-* Added web support for fills [#501](https://github.com/tobrun/flutter-mapbox-gl/pull/501)
-* Add heading to UserLocation and expose UserLocation type [#522](https://github.com/tobrun/flutter-mapbox-gl/pull/522)
-* Update tracked camera position in camera#onIdle [#500](https://github.com/tobrun/flutter-mapbox-gl/pull/500)
-* Improved Image Source Support [#469](https://github.com/tobrun/flutter-mapbox-gl/pull/469)
-
-## 0.9.0,  October 24, 2020
-* Breaking change: CameraUpdate.newLatLngBounds() now supports setting different padding values for left, top, right, bottom with default of 0 for all. Implementations using the old approach with only one padding value for all edges have to be updated. [#382](https://github.com/tobrun/flutter-mapbox-gl/pull/382)
-* Add methods to access projection [#380](https://github.com/tobrun/flutter-mapbox-gl/pull/380)
-* Add fill API support for Android and iOS [#49](https://github.com/tobrun/flutter-mapbox-gl/pull/49)
-* Listen to OnUserLocationUpdated to provide user location to app [#237](https://github.com/tobrun/flutter-mapbox-gl/pull/237)
-* Add support for custom font stackn in symbol options [#359](https://github.com/tobrun/flutter-mapbox-gl/pull/359)
-* Basic ImageSource Support [#409](https://github.com/tobrun/flutter-mapbox-gl/pull/409)
-* Get meters per pixel at latitude [#416](https://github.com/tobrun/flutter-mapbox-gl/pull/416)
+
+* Added web support for
+  fills [#501](https://github.com/tobrun/flutter-mapbox-gl/pull/501)
+* Add heading to UserLocation and expose UserLocation
+  type [#522](https://github.com/tobrun/flutter-mapbox-gl/pull/522)
+* Update tracked camera position in
+  camera#onIdle [#500](https://github.com/tobrun/flutter-mapbox-gl/pull/500)
+* Improved Image Source
+  Support [#469](https://github.com/tobrun/flutter-mapbox-gl/pull/469)
+
+## 0.9.0, October 24, 2020
+
+* Breaking change: CameraUpdate.newLatLngBounds() now supports setting different
+  padding values for left, top, right, bottom with default of 0 for all.
+  Implementations using the old approach with only one padding value for all
+  edges have to be
+  updated. [#382](https://github.com/tobrun/flutter-mapbox-gl/pull/382)
+* Add methods to access
+  projection [#380](https://github.com/tobrun/flutter-mapbox-gl/pull/380)
+* Add fill API support for Android and
+  iOS [#49](https://github.com/tobrun/flutter-mapbox-gl/pull/49)
+* Listen to OnUserLocationUpdated to provide user location to
+  app [#237](https://github.com/tobrun/flutter-mapbox-gl/pull/237)
+* Add support for custom font stackn in symbol
+  options [#359](https://github.com/tobrun/flutter-mapbox-gl/pull/359)
+* Basic ImageSource
+  Support [#409](https://github.com/tobrun/flutter-mapbox-gl/pull/409)
+* Get meters per pixel at
+  latitude [#416](https://github.com/tobrun/flutter-mapbox-gl/pull/416)
 
 ## 0.8.0, August 22, 2020
-- implementation of feature querying [#177](https://github.com/tobrun/flutter-mapbox-gl/pull/177)
-- Batch create/delete of symbols [#279](https://github.com/tobrun/flutter-mapbox-gl/pull/279)
-- Add multi map support [#315](https://github.com/tobrun/flutter-mapbox-gl/pull/315)
-- Add line#getGeometry and symbol#getGeometry [#281](https://github.com/tobrun/flutter-mapbox-gl/pull/281)
+
+- implementation of feature
+  querying [#177](https://github.com/tobrun/flutter-mapbox-gl/pull/177)
+- Batch create/delete of
+  symbols [#279](https://github.com/tobrun/flutter-mapbox-gl/pull/279)
+- Add multi map
+  support [#315](https://github.com/tobrun/flutter-mapbox-gl/pull/315)
+- Add line#getGeometry and
+  symbol#getGeometry [#281](https://github.com/tobrun/flutter-mapbox-gl/pull/281)
 
 ## 0.7.0
+
 - Initial version

maplibre_gl_web/CHANGELOG.md

@@ -13,39 +13,70 @@ see top-level CHANGELOG.md
 ## 0.14.0, Oct 14, 2021
 
 ## 0.13.0, Oct 6, 2021
-🎉 The first release of flutter-maplibre-gl with the complete transition to Maplibre libraries. 🎉
+
+🎉 The first release of flutter-maplibre-gl with the complete transition to
+Maplibre libraries. 🎉
 
 ### Changes cherry-picked/ported from tobrun/flutter-mapbox-gl:0.12.0
-* Dependencies: updated image package [#598](https://github.com/tobrun/flutter-mapbox-gl/pull/598)
-* Fix feature manager on release build [#593](https://github.com/tobrun/flutter-mapbox-gl/pull/593)
-* Emit onTap only for the feature above the others [#589](https://github.com/tobrun/flutter-mapbox-gl/pull/589)
-* Add annotationOrder to web [#588](https://github.com/tobrun/flutter-mapbox-gl/pull/588)
+
+* Dependencies: updated image
+  package [#598](https://github.com/tobrun/flutter-mapbox-gl/pull/598)
+* Fix feature manager on release
+  build [#593](https://github.com/tobrun/flutter-mapbox-gl/pull/593)
+* Emit onTap only for the feature above the
+  others [#589](https://github.com/tobrun/flutter-mapbox-gl/pull/589)
+* Add annotationOrder to
+  web [#588](https://github.com/tobrun/flutter-mapbox-gl/pull/588)
 
 ### Changes cherry-picked/ported from tobrun/flutter-mapbox-gl:0.11.0
-* Fix Mapbox GL JS CSS embedding on web [#551](https://github.com/tobrun/flutter-mapbox-gl/pull/551)
-* Add batch mode of screen locations [#554](https://github.com/tobrun/flutter-mapbox-gl/pull/554)
+
+* Fix Mapbox GL JS CSS embedding on
+  web [#551](https://github.com/tobrun/flutter-mapbox-gl/pull/551)
+* Add batch mode of screen
+  locations [#554](https://github.com/tobrun/flutter-mapbox-gl/pull/554)
 
 ## Below is the original changelog of the tobrun/flutter-mapbox-gl project, before the fork.
 
 ## 0.10.0, February 12, 2020
-* Added web support for fills [#501](https://github.com/tobrun/flutter-mapbox-gl/pull/501)
-* Add heading to UserLocation and expose UserLocation type [#522](https://github.com/tobrun/flutter-mapbox-gl/pull/522)
-* Update tracked camera position in camera#onIdle [#500](https://github.com/tobrun/flutter-mapbox-gl/pull/500)
-* Improved Image Source Support [#469](https://github.com/tobrun/flutter-mapbox-gl/pull/469)
-
-## 0.9.0,  October 24. 2020
-* Breaking change: CameraUpdate.newLatLngBounds() now supports setting different padding values for left, top, right, bottom with default of 0 for all. Implementations using the old approach with only one padding value for all edges have to be updated. [#382](https://github.com/tobrun/flutter-mapbox-gl/pull/382)
-* web:ignore myLocationTrackingMode if myLocationEnabled is false [#363](https://github.com/tobrun/flutter-mapbox-gl/pull/363)
-* Add methods to access projection [#380](https://github.com/tobrun/flutter-mapbox-gl/pull/380)
-* Listen to OnUserLocationUpdated to provide user location to app [#237](https://github.com/tobrun/flutter-mapbox-gl/pull/237)
-* Get meters per pixel at latitude [#416](https://github.com/tobrun/flutter-mapbox-gl/pull/416)
+
+* Added web support for
+  fills [#501](https://github.com/tobrun/flutter-mapbox-gl/pull/501)
+* Add heading to UserLocation and expose UserLocation
+  type [#522](https://github.com/tobrun/flutter-mapbox-gl/pull/522)
+* Update tracked camera position in
+  camera#onIdle [#500](https://github.com/tobrun/flutter-mapbox-gl/pull/500)
+* Improved Image Source
+  Support [#469](https://github.com/tobrun/flutter-mapbox-gl/pull/469)
+
+## 0.9.0, October 24. 2020
+
+* Breaking change: CameraUpdate.newLatLngBounds() now supports setting different
+  padding values for left, top, right, bottom with default of 0 for all.
+  Implementations using the old approach with only one padding value for all
+  edges have to be
+  updated. [#382](https://github.com/tobrun/flutter-mapbox-gl/pull/382)
+* web:ignore myLocationTrackingMode if myLocationEnabled is
+  false [#363](https://github.com/tobrun/flutter-mapbox-gl/pull/363)
+* Add methods to access
+  projection [#380](https://github.com/tobrun/flutter-mapbox-gl/pull/380)
+* Listen to OnUserLocationUpdated to provide user location to
+  app [#237](https://github.com/tobrun/flutter-mapbox-gl/pull/237)
+* Get meters per pixel at
+  latitude [#416](https://github.com/tobrun/flutter-mapbox-gl/pull/416)
 
 ## 0.8.0, August 22, 2020
-- implementation of feature querying [#177](https://github.com/tobrun/flutter-mapbox-gl/pull/177)
-- Allow setting accesstoken in flutter [#321](https://github.com/tobrun/flutter-mapbox-gl/pull/321)
-- Batch create/delete of symbols [#279](https://github.com/tobrun/flutter-mapbox-gl/pull/279)
-- Set dependencies from git [#319](https://github.com/tobrun/flutter-mapbox-gl/pull/319)
-- Add multi map support [#315](https://github.com/tobrun/flutter-mapbox-gl/pull/315)
+
+- implementation of feature
+  querying [#177](https://github.com/tobrun/flutter-mapbox-gl/pull/177)
+- Allow setting accesstoken in
+  flutter [#321](https://github.com/tobrun/flutter-mapbox-gl/pull/321)
+- Batch create/delete of
+  symbols [#279](https://github.com/tobrun/flutter-mapbox-gl/pull/279)
+- Set dependencies from
+  git [#319](https://github.com/tobrun/flutter-mapbox-gl/pull/319)
+- Add multi map
+  support [#315](https://github.com/tobrun/flutter-mapbox-gl/pull/315)
 
 ## 0.7.0
+
 - Initial version