Skip to content
This repository was archived by the owner on Feb 22, 2023. It is now read-only.

Commit c0e7a42

Browse files
authored
Add a PR triage policy to the contributing guide. (#1779)
1 parent debf9cf commit c0e7a42

1 file changed

Lines changed: 27 additions & 12 deletions

File tree

CONTRIBUTING.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
Contributing to Flutter Plugins
2-
===============================
1+
# Contributing to Flutter Plugins
2+
33

44
[![Build Status](https://api.cirrus-ci.com/github/flutter/plugins.svg)](https://cirrus-ci.com/github/flutter/plugins/master)
55

66
_See also: [Flutter's code of conduct](https://flutter.io/design-principles/#code-of-conduct)_
77

8-
Things you will need
9-
--------------------
8+
## Things you will need
9+
1010

1111
* Linux, Mac OS X, or Windows.
1212
* git (used for source version control).
1313
* An ssh client (used to authenticate with GitHub).
1414

15-
Getting the code and configuring your environment
16-
-------------------------------------------------
15+
## Getting the code and configuring your environment
16+
1717

1818
* Ensure all the dependencies described in the previous section are installed.
1919
* Fork `https://github.com/flutter/plugins` into your own GitHub account. If
@@ -29,8 +29,8 @@ Getting the code and configuring your environment
2929
fetch from the master repository, not your clone, when running `git fetch`
3030
et al.)
3131

32-
Running the examples
33-
--------------------
32+
## Running the examples
33+
3434

3535
To run an example with a prebuilt binary from the cloud, switch to that
3636
example's directory, run `pub get` to make sure its dependencies have been
@@ -40,8 +40,7 @@ USB and debugging enabled on that device.
4040
* `cd packages/battery/example`
4141
* `flutter run`
4242

43-
Running the tests
44-
-----------------
43+
## Running the tests
4544

4645
Flutter plugins have both unit tests of their Dart API and integration tests that run on a virtual or actual device.
4746

@@ -58,8 +57,7 @@ cd example
5857
flutter drive test/<name_of_plugin>.dart
5958
```
6059

61-
Contributing code
62-
-----------------
60+
## Contributing code
6361

6462
We gladly accept contributions via GitHub pull requests.
6563

@@ -112,3 +110,20 @@ You must complete the
112110
You can do this online, and it only takes a minute.
113111
If you've never submitted code before, you must add your (or your
114112
organization's) name and contact info to the [AUTHORS](AUTHORS) file.
113+
114+
### The review process
115+
116+
* This is a new process we are currently experimenting with, feedback on the process is welcomed at the Gitter contributors channel. *
117+
118+
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"](https://github.com/flutter/flutter/issues?q=is%3Aopen+is%3Aissue+label%3Aplugin+sort%3Areactions-%2B1-desc). Non trivial PRs should have an associated issue that will be used for prioritization. See the [prioritization section](https://github.com/flutter/flutter/wiki/Issue-hygiene#prioritization) in the Flutter wiki to understand how issues are prioritized.
119+
120+
Newly opened PRs first go through initial triage which results in one of:
121+
* **Merging the PR** - if the PR can be quickly reviewed and looks good.
122+
* **Closing the PR** - if the PR maintainer decides that the PR should not be merged.
123+
* **Moving the PR to the backlog** - if the review requires non trivial effort and the issue isn't a priority; in this case the maintainer will:
124+
* Make sure that the PR has an associated issue labeled with "plugin".
125+
* Add the "backlog" label to the issue.
126+
* 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.
127+
* **Starting a non trivial review** - if the review requires non trivial effort and the issue is a priority; in this case the maintainer will:
128+
* Add the "in review" label to the issue.
129+
* Self assign the PR.

0 commit comments

Comments
 (0)