From 529d25045393430742daf06517417a7687074dba Mon Sep 17 00:00:00 2001 From: Ian Hickson Date: Fri, 1 Jun 2018 12:04:20 -0700 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 31 +++++++++++++++++++++---------- 1 file changed, 21 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3705d282d77..43fca9b7e80 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,6 +5,25 @@ Contributing to Flutter _See also: [Flutter's code of conduct](https://flutter.io/design-principles/#code-of-conduct)_ +Welcome +------- + +We gladly accept contributions via GitHub pull requests. + +Please become familiar with our +[style guide](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo) and +[design philosophy](https://flutter.io/design-principles/). These guidelines are intended to +keep the code consistent and avoid common pitfalls, and being familiar with them will +make everything much easier for you. If you have questions about our processes or are looking +for random tips and tricks, you may be interested in the [engine wiki](https://github.com/flutter/engine/wiki) and [framework wiki](https://github.com/flutter/flutter/wiki). + +This document will introduce you to the basic steps for developing for the Flutter framework (Dart). +If you're interested in developing for the Flutter engine (C++, Java, Objective C), please +switch to [the engine repo's `CONTRIBUTING.md` document](https://github.com/flutter/engine/blob/master/CONTRIBUTING.md). + +If you have an itch, work on that. If you are just looking for something good to start with, consider +[the issues marked "easy fix"](https://github.com/flutter/flutter/issues?q=is%3Aopen+is%3Aissue+label%3A%22easy+fix%22+sort%3Areactions-%2B1-desc) in our issues list. + Things you will need -------------------- @@ -151,16 +170,8 @@ The pre-built flutter tool runs in release mode with the observatory off by defa To enable debugging mode and the observatory on the `flutter` tool, uncomment the `FLUTTER_TOOL_ARGS` line in the `bin/flutter` shell script. -Contributing code ------------------ - -We gladly accept contributions via GitHub pull requests. - -Please peruse our -[style guides](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo) 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. +Using git +--------- To start working on a patch: