Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions packages/google_maps_flutter/google_maps_flutter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,3 +170,11 @@ class MapSampleState extends State<MapSample> {
```

See the `example` directory for a complete sample app.

## Support
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "Resources" would be a better section title than "Support", since we don't have an official support system.


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).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


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).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.