Repository navigation
Description
flutter-team-archive/plugins#5339 will add the ability to manage our README code snippets with code-excerpt so that they stop getting out of sync with changes in APIs, Dart, or lints, as well as sometimes just having typos that make them incorrect from the start. Once that lands we should start proactively updating all of our READMEs to use it, rather than waiting for bugs to be found, since it's a pretty easy change and will almost certainly find and fix latent issues in our READMEs given the steady stream of PRs we get about them.
That will also allow us to turn on enforcement in the repo to ensure that new code samples are written that way, so we don't create new documentation tech debt by accident.
Here's the list of exceptions we need to eliminate:
- camera_web [camera_web] Adopt code excerpts in README packages#4584
- cross_file [cross_file] adopt code excerpts in README packages#5347
- css_colors [css_colors] Adopt code excerpts in README packages#5478
- cupertino_ui
- espresso
- extension_google_sign_in_as_googleapis_auth [extension_google_sign_in_as_googleapis_auth] Adopt code excerpts in … packages#5496
- flutter_image [flutter_image] Adopt code excerpts in README packages#5498
- flutter_markdown [flutter_markdown] Adopt code excerpts in README packages#4656
- go_router
- go_router_builder [go_router_builder] Fixes readme typos and uses code excerpts. packages#7280
- google_maps_flutter/google_maps_flutter
- google_sign_in/google_sign_in [google_sign_in] Adopt code excerpts in README packages#5521
- google_sign_in_web
- image_picker [image_picker] Adopt readme excerpts packages#3507
- image_picker_for_web
- in_app_purchase/in_app_purchase
- ios_platform_images
- flutter_svg [flutter_svg] Adopt code excerpts packages#8181
- flutter_svg_test
- multicast_dns [multicast_dns] Adjust README packages#5529
- palette_generator [palette_generator] Remove unmanaged code snippet packages#7962
- path_provider [path_provider] Adopt readme excerpts packages#3494
- pigeon
- plugin_platform_interface [plugin_platform_interface] Adopt code-excerpts packages#4534
- material_ui
- mustache_template
- pointer_interceptor
- quick_actions/quick_actions
- rfw
- shared_preferences [shared_preferences] Adopt readme excerpts packages#3491
- url_launcher [url_launcher] Update README to use code excerpts. flutter-team-archive/plugins#6042
- webview_flutter_android
- webview_flutter_web
Activity
[-][plugins] Adopt `code-excerpt` across all READMEs[/-][+][plugins/packages] Adopt `code-excerpt` across all READMEs[/+]stuartmorgan-g commentedon Apr 29, 2022
We should do this for flutter/package as well; I'm adding the tooling support there now.
stuartmorgan-g commentedon Aug 15, 2022
https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#readme-code has the instructions for setting this up.
[-][plugins/packages] Adopt `code-excerpt` across all READMEs[/-][+][packages] Adopt `code-excerpt` across all READMEs[/+]87 remaining items
[go_router_builder] Fixes readme typos and uses code excerpts. (flutt…
[palette_generator] Remove unmanaged code snippet (flutter#7962)
[flutter_svg] Adopt code excerpts (flutter#8181)
[pointer_interceptor] Adopt code-excerpts for README
[in_app_purchase_storekit] Migrate StoreKit1 core to Swift
[quick_actions] Adopt code-excerpts for README
[espresso] Adopt code-excerpts for README
[pointer_interceptor] Adopt code-excerpts for README
[in_app_purchase_storekit] Migrate StoreKit1 core to Swift
[quick_actions] Adopt code-excerpts for README
[espresso] Adopt code-excerpts for README
[pointer_interceptor] Adopt code-excerpts for README (#12641)
[espresso] Adopt code-excerpts for README (#12644)
[In_app _purchase] README excerpt examples and changelog (#12739)
Bhagyaprasad92 commentedon Oct 23, 2026
Hi! I'd like to work on the
cupertino_uiitem from this checklist by updating its README code examples to usecode-excerpt,I'll first check the current repository conventions and existing examples, then submit a focused PR to
flutter/packages,Please let me know if this item is already being handled or if there are any specific expectations I should follow.