Update google_maps_flutter README with support, SLA and contribution … #10422
Conversation
…details Added support information and contribution guidelines.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the README.md for google_maps_flutter by adding a new 'Support' section. This section clarifies the open-source support model, semantic versioning adherence, and provides guidance for filing issues and contributing. My review includes a suggestion to update the contributing guide link to point to the more specific guide for the flutter/packages repository, which will be more helpful for potential contributors.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
|
||
| ## Support | ||
|
|
||
| This package is offered via an open source license. It is not governed by the Google Maps Platform Support [Technical Support Services Guidelines](https://cloud.google.com/maps-platform/terms/tssg), the [SLA](https://cloud.google.com/maps-platform/terms/sla), or the [Deprecation Policy](https://cloud.google.com/maps-platform/terms) (however, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service). |
There was a problem hiding this comment.
This package is offered via an open source license.
This is true of all of our packages, so not something we would say in every README.
|
|
||
| ## Support | ||
|
|
||
| This package is offered via an open source license. It is not governed by the Google Maps Platform Support [Technical Support Services Guidelines](https://cloud.google.com/maps-platform/terms/tssg), the [SLA](https://cloud.google.com/maps-platform/terms/sla), or the [Deprecation Policy](https://cloud.google.com/maps-platform/terms) (however, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service). |
There was a problem hiding this comment.
For the rest of this paragraph, this is a lot of SDK-specific detail that we would generally not document at this level. Is there a general policy docs page that we can link to instead?
|
|
||
| This package is offered via an open source license. It is not governed by the Google Maps Platform Support [Technical Support Services Guidelines](https://cloud.google.com/maps-platform/terms/tssg), the [SLA](https://cloud.google.com/maps-platform/terms/sla), or the [Deprecation Policy](https://cloud.google.com/maps-platform/terms) (however, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service). | ||
|
|
||
| This package adheres to [semantic versioning](https://semver.org/) to indicate when backwards-incompatible changes are introduced. Accordingly, while the library is in version 0.x, backwards-incompatible changes may be introduced at any time. |
There was a problem hiding this comment.
All of our packages uses semver, as does essentially the entire Dart package ecosystem, so we don't say this at a per-package level.
|
|
||
| This package adheres to [semantic versioning](https://semver.org/) to indicate when backwards-incompatible changes are introduced. Accordingly, while the library is in version 0.x, backwards-incompatible changes may be introduced at any time. | ||
|
|
||
| If you find a bug, or have a feature request, please [file an issue](https://github.com/flutter/flutter/issues) on GitHub. If you would like to get answers to technical questions from other Google Maps Platform developers, ask through one of our [developer community channels](https://developers.google.com/maps/developer-community). If you'd like to contribute, please check the [Contributing guide](https://github.com/flutter/packages/blob/main/CONTRIBUTING.md). |
There was a problem hiding this comment.
If you find a bug, or have a feature request, please file an issue on GitHub.
There is already a standardized link to this on pub.dev, which is where essentially everyone reads this documentation, so we don't generally include it.
If you'd like to contribute, please check the Contributing guide.
We just document this at the repo level, not in every package.
|
|
||
| See the `example` directory for a complete sample app. | ||
|
|
||
| ## Support |
There was a problem hiding this comment.
I think "Resources" would be a better section title than "Support", since we don't have an official support system.
|
|
||
| This package adheres to [semantic versioning](https://semver.org/) to indicate when backwards-incompatible changes are introduced. Accordingly, while the library is in version 0.x, backwards-incompatible changes may be introduced at any time. | ||
|
|
||
| If you find a bug, or have a feature request, please [file an issue](https://github.com/flutter/flutter/issues) on GitHub. If you would like to get answers to technical questions from other Google Maps Platform developers, ask through one of our [developer community channels](https://developers.google.com/maps/developer-community). If you'd like to contribute, please check the [Contributing guide](https://github.com/flutter/packages/blob/main/CONTRIBUTING.md). |
There was a problem hiding this comment.
If you would like to get answers to technical questions from other Google Maps Platform developers, ask through one of our developer community channels.
In the context of this README, "our" would be the Flutter team, and this is not a Flutter team resource. This seems like a potentially useful resource to link to, it'll just need language that doesn't sound like it's affiliated with the Flutter team.
2 participants
Added Google Maps Platform support information (SLAs, Deprecation policy, how to report issues) and contribution guidelines.