CONTRIBUTING.md

Contributing to Flutter Plugins

See also: Flutter's code of conduct

Welcome

For an introduction to contributing to Flutter, see our contributor guide.

Additional resources specific to the plugins repository:

• Setting up the Plugins development environment, which covers the setup process for this repository.
• Plugins repository structure, to get an overview of how this repository is laid out.
• Plugin tests, which explains the different kinds of tests used for plugins, where to find them, and how to run them. As explained in the Flutter guide, PRs needs tests, so this is critical to read before submitting a PR.

Important note

As of January 2021, we are no longer accepting non-critical PRs for plugins for which there is a corresponding Flutter Community Plus Plugin, as we hope in time to be able to transition users to those versions of the plugins. If you have a PR for something other than a critical issue (crashes, build failures, null safety, etc.) for any of the following plugins, we encourage you to submit it there instead:

• android_alarm_manager
• android_intent
• battery
• connectivity
• device_info
• package_info
• sensors
• share
• wifi_info_flutter (corresponds to network_info_plus)

Other notes

Style

Flutter plugins follow Google style—or Flutter style for Dart—for the languages they use, and use auto-formatters:

• Dart formatted with dart format
• C++ formatted with clang-format
  • Note: The Linux plugins generally follow idiomatic GObject-based C style. See the engine style notes for more details, and exceptions.
• Java formatted with google-java-format
• Objective-C formatted with clang-format

The review process

Reviewing PRs often requires a non-trivial amount of time. We prioritize issues, not PRs, so that we use our maintainers' time in the most impactful way. Issues pertaining to this repository are managed in the flutter/flutter issue tracker and are labeled with "plugin". Non-trivial PRs should have an associated issue that will be used for prioritization. See the prioritization section in the Flutter wiki to understand how issues are prioritized.

Newly opened PRs first go through initial triage which results in one of:

• Merging the PR - if the PR can be quickly reviewed and looks good.
• Requesting minor changes - if the PR can be quickly reviewed, but needs changes.
• Moving the PR to the backlog - if the review requires non-trivial effort and the issue isn't currently a priority; in this case the maintainer will:
  • Add the "backlog" label to the issue.
  • Leave a comment on the PR explaining that the review is not trivial and that the issue will be looked at according to priority order.
• Starting a non-trivial review - if the review requires non-trivial effort and the issue is a priority; in this case the maintainer will:
  • Add the "in review" label to the issue.
  • Self assign the PR.
• Closing the PR - if the PR maintainer decides that the PR should not be merged.

Please be aware that there is currently a significant backlog, so reviews for plugin PRs will in most cases take significantly longer to begin than the two-week timeframe given in the main Flutter PR guide. An effort is underway to work through the backlog, but it will take time. If you are interested in hepling out (e.g., by doing initial reviews looking for obvious problems like missing or failing tests), please reach out on Discord in #hackers-ecosystem.

Releasing

If you are a team member landing a PR, or just want to know what the release process is for plugin changes, see the release documentation.