From 5fbe83ba6bb07b4bdafd2c19f12902e1f5c6d884 Mon Sep 17 00:00:00 2001 From: Amir Hardon Date: Thu, 27 Jun 2019 18:35:32 -0700 Subject: [PATCH 1/3] Add a PR triage policy to the contributing guide. --- CONTRIBUTING.md | 37 +++++++++++++++++++++++++------------ 1 file changed, 25 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa8438866b48..fd9fa5c8e698 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,19 +1,19 @@ -Contributing to Flutter Plugins -=============================== +# Contributing to Flutter Plugins + [![Build Status](https://api.cirrus-ci.com/github/flutter/plugins.svg)](https://cirrus-ci.com/github/flutter/plugins/master) _See also: [Flutter's code of conduct](https://flutter.io/design-principles/#code-of-conduct)_ -Things you will need --------------------- +## Things you will need + * Linux, Mac OS X, or Windows. * git (used for source version control). * An ssh client (used to authenticate with GitHub). -Getting the code and configuring your environment -------------------------------------------------- +## Getting the code and configuring your environment + * Ensure all the dependencies described in the previous section are installed. * Fork `https://github.com/flutter/plugins` into your own GitHub account. If @@ -29,8 +29,8 @@ Getting the code and configuring your environment fetch from the master repository, not your clone, when running `git fetch` et al.) -Running the examples --------------------- +## Running the examples + To run an example with a prebuilt binary from the cloud, switch to that example's directory, run `pub get` to make sure its dependencies have been @@ -40,8 +40,7 @@ USB and debugging enabled on that device. * `cd packages/battery/example` * `flutter run` -Running the tests ------------------ +## Running the tests Flutter plugins have both unit tests of their Dart API and integration tests that run on a virtual or actual device. @@ -58,8 +57,7 @@ cd example flutter drive test/.dart ``` -Contributing code ------------------ +## Contributing code We gladly accept contributions via GitHub pull requests. @@ -112,3 +110,18 @@ You must complete the You can do this online, and it only takes a minute. If you've never submitted code before, you must add your (or your organization's) name and contact info to the [AUTHORS](AUTHORS) file. + +### The review process + +Reviewing PRs often requires a non trivial amount of time, as our goal is to use maintainers' time in the most impactful way, we perform prioritization on issues and not on PRs. 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. + +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. + * **Closing the PR** - if the PR maintainer decides that the PR should not be merged. + * **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: + * Make sure that the PR has an associated issue labeled with "plugin". + * 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. From 59253c78925c0075ebbce25fc90098c5f88479d1 Mon Sep 17 00:00:00 2001 From: Amir Hardon Date: Fri, 28 Jun 2019 15:49:24 -0700 Subject: [PATCH 2/3] fix grammar --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fd9fa5c8e698..3d595295caec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -113,7 +113,7 @@ organization's) name and contact info to the [AUTHORS](AUTHORS) file. ### The review process -Reviewing PRs often requires a non trivial amount of time, as our goal is to use maintainers' time in the most impactful way, we perform prioritization on issues and not on PRs. 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. +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. 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. From 7b8b7e45d39329a1f79575b1cf8126a74e2f223e Mon Sep 17 00:00:00 2001 From: Amir Hardon Date: Fri, 28 Jun 2019 15:59:59 -0700 Subject: [PATCH 3/3] note that the process is experimental --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d595295caec..936b5b921ebf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -113,6 +113,8 @@ organization's) name and contact info to the [AUTHORS](AUTHORS) file. ### The review process +* This is a new process we are currently experimenting with, feedback on the process is welcomed at the Gitter contributors channel. * + 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. Newly opened PRs first go through initial triage which results in one of: