2015-11-09 05:33:00 +00:00
Contributing to Flutter
=======================
[![Build Status ](https://travis-ci.org/flutter/flutter.svg )](https://travis-ci.org/flutter/flutter)
Things you will need
--------------------
* Linux or Mac OS X. (Windows is not yet supported.)
* git (used for source version control).
* An IDE. We recommend [Atom ](https://github.com/flutter/engine/wiki/Using-Atom-with-Flutter ).
* An ssh client (used to authenticate with GitHub).
* Python (used by some of our tools).
* The Android platform tools (see [Issue #55 ](https://github.com/flutter/flutter/issues/55 )
2015-11-09 06:18:16 +00:00
about downloading the Android platform tools automatically).
2016-02-08 21:39:24 +00:00
_If you're also working on the Flutter engine, you can use the
2015-11-09 06:18:16 +00:00
copy of the Android platform tools in
2016-02-08 21:39:24 +00:00
`.../engine/src/third_party/android_tools/sdk/platform-tools` ._
2015-11-09 05:33:00 +00:00
- Mac: `brew install android-platform-tools`
- Linux: `sudo apt-get install android-tools-adb`
Getting the code and configuring your environment
-------------------------------------------------
* Ensure all the dependencies described in the previous section, in particular
2016-02-15 18:46:24 +00:00
git, ssh, and python are installed. Ensure that `adb`
(from the Android platform tools) is in your path (e.g.,
that `which adb` prints sensible output).
2015-11-09 05:33:00 +00:00
* Fork `https://github.com/flutter/flutter` into your own GitHub account. If
you already have a fork, and are now installing a development environment on
a new machine, make sure you've updated your fork so that you don't use stale
configuration options from long ago.
* If you haven't configured your machine with an SSH key that's known to github then
follow the directions here: https://help.github.com/articles/generating-ssh-keys/.
* `git clone git@github.com:<your_name_here>/flutter.git`
* `cd flutter`
* `git remote add upstream git@github.com:flutter/flutter.git` (So that you
fetch from the master repository, not your clone, when running `git fetch`
et al.)
2015-11-10 20:31:29 +00:00
* Run `dart ./dev/update_packages.dart` This will fetch all the Dart packages that
2015-11-09 05:33:00 +00:00
Flutter depends on. You can replicate what this script does by running
`pub get` in each directory that contains a `pubspec.yaml` file.
* Add this repository's `bin` directory to your path. That will let you use the
2016-02-15 18:46:24 +00:00
`flutter` command in this directory more easily.
2015-11-09 05:33:00 +00:00
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
2016-02-17 15:34:59 +00:00
downloaded, and use `flutter run` . Make sure you have a device connected over
2015-11-09 05:33:00 +00:00
USB and debugging enabled on that device.
2016-02-17 15:34:59 +00:00
* `cd examples/hello_world; flutter run`
2015-11-09 05:33:00 +00:00
You can also specify a particular Dart file to run if you want to run an example
that doesn't have a `lib/main.dart` file using the `-t` command-line option. For
example, to run the `tabs.dart` example in the [examples/widgets ](examples/widgets )
directory on a connected Android device, from that directory you would run:
2016-02-17 15:34:59 +00:00
* `flutter run -t tabs.dart`
2015-11-09 05:33:00 +00:00
When running code from the examples directory, any changes you make to the
example code, as well as any changes to Dart code in the
[packages/flutter ](packages/flutter ) directory and subdirectories, will
automatically be picked when you relaunch the app. You can do the same for your
own code by mimicking the `pubspec.yaml` files in the `examples` subdirectories.
Running the tests
-----------------
2015-12-16 06:32:45 +00:00
To automatically find all files named `_test.dart` inside a package's `test/` subdirectory, and run them inside the flutter shell as a test, use the `flutter test` command, e.g:
2015-11-09 05:33:00 +00:00
2015-12-08 22:09:47 +00:00
* `cd examples/stocks`
2015-12-08 21:51:05 +00:00
* `flutter test`
2015-11-09 05:33:00 +00:00
2015-12-08 22:09:47 +00:00
Individual tests can also be run directly, e.g. `flutter test lib/my_app_test.dart`
2015-12-08 21:51:05 +00:00
Flutter tests use [package:flutter_test ](https://github.com/flutter/flutter/tree/master/packages/flutter_test ) which provides flutter-specific extensions on top of [package:test ](https://pub.dartlang.org/packages/test ).
2015-11-09 05:33:00 +00:00
2015-12-08 22:09:47 +00:00
`flutter test` runs tests inside the flutter shell. Some packages inside the flutter repository can be run inside the dart command line VM as well as the flutter shell, `packages/newton` and `packages/flutter_tools` are two such examples:
* `cd packages/newton`
* `pub run test`
2015-12-16 06:32:45 +00:00
`flutter test --flutter-repo` is a shortcut for those working on the flutter repository itself which runs all tests inside the `flutter` package regardless of the current working directory.
To run all the tests for the entire Flutter repository, the same way that Travis runs them, run `travis/test.sh` .
2015-12-08 22:09:47 +00:00
2015-12-08 22:38:03 +00:00
If you've built [your own flutter engine ](#working-on-the-engine-and-the-framework-at-the-same-time ), you can pass `--debug` or `--release` to change what flutter shell `flutter test` uses.
2015-12-16 06:32:45 +00:00
To do this with the `travis/test.sh` script, you can use the `FLUTTER_ENGINE` environment variable.
2015-11-09 05:33:00 +00:00
2015-12-08 21:51:05 +00:00
Note: Flutter tests are headless, you won't see any UI. You can use
2015-11-09 08:30:45 +00:00
`print` to generate console output or you can interact with the DartVM
via observatory at [http://localhost:8181/ ](http://localhost:8181/ ).
2015-11-09 05:33:00 +00:00
Adding a test
-------------
2015-12-16 06:32:45 +00:00
To add a test to the Flutter package, simply create a file whose name
ends with `_test.dart` in the `packages/flutter/test` directory. The
test should have a `main` function and use the `test` package.
2015-11-09 05:33:00 +00:00
Contributing code
-----------------
We gladly accept contributions via GitHub pull requests.
To start working on a patch:
* `git fetch upstream`
* `git checkout upstream/master -b name_of_your_branch`
2016-02-23 16:56:18 +00:00
* Hack away. Please peruse our
[style guides ](https://flutter.io/style-guide/ ) and
[design principles ](https://flutter.io/design-principles/ ) before
working on anything non-trivial. These guidelines are intended to
keep the code consistent and avoid common pitfalls.
2015-11-09 08:30:45 +00:00
* `git commit -a -m "<your informative commit message>"`
2015-11-09 05:33:00 +00:00
* `git push origin name_of_your_branch`
To send us a pull request:
* `git pull-request` (if you are using [Hub ](http://github.com/github/hub/ )) or
go to `https://github.com/flutter/flutter` and click the
"Compare & pull request" button
Please make sure all your checkins have detailed commit messages explaining the patch.
If you made multiple commits for a single pull request, either make sure each one has a detailed
message explaining that specific commit, or squash your commits into one single checkin with a
detailed message before sending the pull request.
2016-02-02 20:14:08 +00:00
Once you've gotten an LGTM from a project maintainer, submit your changes to the
`master` branch using one of the following methods:
2016-02-02 19:17:16 +00:00
* 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)
* `git push upstream name_of_your_branch:master` (requires commit access)
2015-11-09 05:33:00 +00:00
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.
Working on the engine and the framework at the same time
--------------------------------------------------------
You can work both with this repository (flutter.git) and the Flutter
[engine repository ](https://github.com/flutter/engine ) at the same time using
the following steps.
1. Follow the instructions above for creating a working copy of this repository.
2. Follow the [contributing instructions ](https://github.com/flutter/engine/blob/master/CONTRIBUTING.md )
for the engine repository to create a working copy of the engine. When you
create the `.gclient` file for the engine, be sure to create it in a
directory named `engine` that is a sibling of the directory in which you
cloned this repository. For example, if you cloned this repository into the
`/foo/bar/flutter` directory, you should create the `.gclient` file in the
`/foo/bar/engine` directory. The actual code from the engine repository will
end up in `/foo/bar/engine/src` because `gclient` creates a `src` directory
underneath the directory that contains the `.gclient` file.
3. To run tests on your host machine, build one of the host configurations
(e.g., `out/Debug` ). To run examples on Android, build one of the Android
configurations (e.g., `out/android_Debug` ).
2015-11-09 08:30:45 +00:00
You should now be able to run the tests against your locally built
engine using the `flutter test --debug` command. To run one of the
examples on your device using your locally built engine, use the
`--debug` option to the `flutter` tool:
2015-11-09 05:33:00 +00:00
2016-02-17 15:34:59 +00:00
* `flutter run --debug`
2015-11-09 05:33:00 +00:00
2015-11-09 08:30:45 +00:00
If you want to test the release version instead of the debug version,
use `--release` instead of `--debug` .
2015-11-09 05:33:00 +00:00
Making a breaking change to the engine
--------------------------------------
If you make a breaking change to the engine, you'll need to land you change in a
few steps:
1. Land your change in the engine repository.
2. Publish a new version of the engine that contains your change. See the
engine's [release process ](https://github.com/flutter/engine/wiki/Release-process )
for instructions about how to publish a new version of the engine. Publishing
a new version is important in order to not break folks using prebuilt
binaries in their workflow (e.g., our customers).
3. Land a change that update our dependency on the `sky_engine` and
`sky_services` packages to point to the new version of the engine that you
just published. These dependencies are defined by [packages/flutter/pubspec.yaml ](packages/flutter/pubspec.yaml ).
After changing the `pubspec.yaml` file, you'll need to run
2015-11-11 00:06:09 +00:00
`./dev/update_packages.dart` to update all the packages in this repository to
2015-11-09 05:33:00 +00:00
see the new dependency. As part of landing this change, you should make
whatever other changes are needed in this repository to account for your
breaking change.