Skip to content

Commit

Permalink
Update CONTRIBUTING.md (flutter#1374)
Browse files Browse the repository at this point in the history
Explains how to run the tests and process updates
  • Loading branch information
collinjackson authored Mar 21, 2019
1 parent b7026db commit 81a5995
Showing 1 changed file with 26 additions and 11 deletions.
37 changes: 26 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Contributing to Flutter
=======================
Contributing to Flutter Plugins
===============================

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

Expand Down Expand Up @@ -40,6 +40,24 @@ USB and debugging enabled on that device.
* `cd packages/battery/example`
* `flutter run`

Running the tests
-----------------

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

To run the unit tests:

```
flutter test test/<name_of_plugin>_test.dart
```

To run the integration tests:

```
cd example
flutter drive test/<name_of_plugin>.dart
```

Contributing code
-----------------

Expand Down Expand Up @@ -74,19 +92,16 @@ To send us a pull request:

Please make sure all your checkins have detailed commit messages explaining the patch.

Once you've gotten an LGTM from a project maintainer and once your PR has received
the green light from all our automated testing (Travis, AppVeyor, etc), submit your
changes to the `master` branch using one of the following methods:
Plugins tests are run automatically on contributions using Cirrus CI. However, due to
cost constraints, pull requests from non-committers may not run all the tests
automatically.

* Wait for one of the project maintainers to submit it for you.
* Click the green "Merge pull request" button on the GitHub UI of your pull
request (requires commit access).
Once you've gotten an LGTM from a project maintainer and once your PR has received
the green light from all our automated testing, wait for one the package maintainers
to merge the pull request and `pub submit` any affected packages.

You must complete the
[Contributor License Agreement](https://cla.developers.google.com/clas).
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.

We grant commit access to people who have gained our trust and demonstrated
a commitment to Flutter.

0 comments on commit 81a5995

Please sign in to comment.