Skip to content

Commit

Permalink
βœ’ Spell Check All .md Files Related to Flutter πŸ’™ (flutter#61564)
Browse files Browse the repository at this point in the history
* πŸ› Fix Spelling Issues in Main README.md

* πŸ› Fix spelling issues in dev README.md

* πŸ› Fix spelling issues in complex_layout README.md

* πŸ› Fix spelling issues in macrobenchmarks README.md

* πŸ› Fix spelling issues in platform_views_layout README.md

* πŸ› Fix spelling issues in test_Apps/stocks README.md

* πŸ› Fix spelling issues in bots README.md

* βœ’ Spell Check dev/ci README.md

* βœ’ Spell Check dev/ci/docker_linux README.md

* βœ’ Spell Check dev/devicelab README.md

* βœ’ Spell Check dev/docs README.md

* βœ’ Spell Check dev/snippets README.md

* βœ’ Spell Check dev/snippets/config/templates README.md

* βœ’ Spell Check dev/tools/gen_keycodes README.md

* βœ’ Spell Check dev/tools/vitool README.md

* βœ’ Spell Check examples/catalog README.md

* βœ’ Spell Check examples/flutter_view README.md

* βœ’ Spell Check examples/image_list README.md

* βœ’ Spell Check examples/layers README.md

* βœ’ Spell Check examples/platform_channel README.md

* βœ’ Spell Check examples/platform_channel_swift README.md

* βœ’ Spell Check examples/platform_view README.md

* βœ’ Spell Check packages/_flutter_web_build_script README.md

* βœ’ Spell Check packages/flutter_localizations README.md

* βœ’ Spell Check packages/flutter_tools README.md

* βœ’ Spell Check CODE_OF_CONDUCT.md

* βœ’ Spell Check dev/integration_test/android_splash_screens/splash_Screen_load_rotate README.md

* βœ’ Spell Check dev/integration_test/android_views README.md

* βœ’ Spell Check dev/integration_tests/flutter_driver_screenshot_test README.md

* βœ’ Spell Check dev/integration_tests/flutter_gallery README.md

* βœ’ Spell Check dev/integration_tests/gradle_deprecated_settings README.md

* βœ’ Spell Check dev/integration_tests/ios_add2app_life_cycle README.md

* βœ’ Spell Check dev/integration_tests/ios_host_app README.md

* βœ’ Spell Check dev/integration_tests/ios_platform_view_tests README.md

* βœ’ Spell Check dev/automated_tests/flutter_test README.md

* βœ’ Spell Check .github/PULL_REQUEST_TEMPLATE.md

* βœ’ Spell Check .hithub/ISSUE_TEMPLATE/ACTIVATION.md

* βœ’ Spell Check .github/ISSUE_TEMPLATE/BUG.md

* βœ’ Spell Check .github/ISSUE_TEMPLATE/feature_request.md

* βœ’ Spell Check .github/ISSUE_TEMPLATE/performance_others.md

* βœ’ Spell Check .github/ISSUE_TEMPLATE/performance_speed.md

* βœ’ Spell Check packages/flutter_tools/doc/daemon.md

* βœ’ Spell Check packages/flutter_tools/fuchsia_enrtypoint_shim/README.md

* βœ’ Minimize line to 80 columns

* βœ’ Minimize line to 80 columns

* βœ’ Fix Typo

* βœ’ Chnaged numbers to 1 for testing purposes

* βœ’ Changed numbers to 1 for testing purposes

* ❌ Remove 'a' which is a typo

* βœ’ Change a sentence to be better

* βœ’ Remove 'a' which is a typo

* βœ’ Fix small issue

* βœ’ Fix small typo

* βœ’ Fix some typos

* ❌ Remove trailing space

* ❌ Remove trailing space

* πŸ› Fix small typo

* βœ’ Fix Typo

* πŸ› Fix small bug
  • Loading branch information
YazeedAlKhalaf authored Jul 23, 2020
1 parent 9f04086 commit d41b1fb
Show file tree
Hide file tree
Showing 43 changed files with 258 additions and 230 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/ACTIVATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ assignees: ''
* https://stackoverflow.com/questions/tagged/flutter?sort=frequent
If you have found a bug or if our documentation doesn't have an answer
to what you're looking for, then fill our the template below. Please read
to what you're looking for, then fill out the template below. Please read
our guide to filing a bug first: https://flutter.dev/docs/resources/bug-reports
-->

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/BUG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ assignees: ''
* https://stackoverflow.com/questions/tagged/flutter?sort=frequent
If you have found a bug or if our documentation doesn't have an answer
to what you're looking for, then fill our the template below. Please read
to what you're looking for, then fill out the template below. Please read
our guide to filing a bug first: https://flutter.dev/docs/resources/bug-reports
-->

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ assignees: ''
* https://stackoverflow.com/questions/tagged/flutter?sort=frequent
If you have found a bug or if our documentation doesn't have an answer
to what you're looking for, then fill our the template below. Please read
to what you're looking for, then fill out the template below. Please read
our guide to filing a bug first: https://flutter.dev/docs/resources/bug-reports
-->

Expand All @@ -29,7 +29,7 @@ assignees: ''
Is your feature request related to a problem? Please give a clear and
concise description of what the problem is.
Describe alternative solutions you've considered. Is there a package
Describe the alternative solutions you've considered. Is there a package
on pub.dev/flutter that already solves this?
-->

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/performance_others.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ assignees: ''
* https://api.flutter.dev/
* https://stackoverflow.com/questions/tagged/flutter?sort=frequent
If you have found a performance problem, then fill our the template below.
If you have found a performance problem, then fill out the template below.
Please read our guide to filing a bug first: https://flutter.dev/docs/resources/bug-reports
-->

Expand All @@ -39,7 +39,7 @@ assignees: ''
<!--
Please tell us which target platform(s) the problem occurs (Android / iOS / Web / macOS / Linux / Windows)
Which target OS version, for Web, browser, is the test system running?
Does the problem occur on emulator/simulator as well as on physical devices?
Does the problem occur on an emulator/simulator as well as on physical devices?
-->

**Target Platform:**
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/performance_speed.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ assignees: ''
* https://api.flutter.dev/
* https://stackoverflow.com/questions/tagged/flutter?sort=frequent
If you have found a performance problem, then fill our the template below.
If you have found a performance problem, then fill out the template below.
Please read our guide to filing a bug first: https://flutter.dev/docs/resources/bug-reports
-->

Expand Down
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@

I added the following tests:

*Replace this with a list of the tests that you added as part of this PR. A change in behaviour with no test covering it
*Replace this with a list of the tests that you added as part of this PR. A change in behavior with no test covering it
will likely get reverted accidentally sooner or later. PRs must include tests for all changed/updated/fixed behaviors. See [Test Coverage].*

## Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (`[x]`). This will ensure a smooth and quick review process.
Before you create this PR, confirm that it meets all requirements listed below by checking the relevant checkboxes (`[x]`). This will ensure a smooth and quick review process.

- [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
- [ ] I signed the [CLA].
Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ an expert in all the systems. Once you find the answer, document it in
the first place you looked. That way, the next person will be brought
up to speed even quicker.

!["I try not to make fun of people for admitting they don't know things, because for each thing 'everyone knows' by the time they're adults, every day there are, on average, 10,000 people in the US hearing about it for the first time. If I make fun of people, I train them not to tell me when they have those moments. And I miss out on the fun." "Diet coke and mentos thing? What's that?" "Oh man! We're going to the grocery store." "Why?" "You're one of today's lucky 10,000."](https://imgs.xkcd.com/comics/ten_thousand.png)
!["I try not to make fun of people for admitting they don't know things, because for each thing 'everyone knows' by the time they're adults, every day there are, on average, 10,000 people in the US hearing about it for the first time. If I make fun of people, I train them not to tell me when they have those moments. And I miss out on the fun." "Diet coke and mentos thing? What's that?" "Oh, man! We're going to the grocery store." "Why?" "You're one of today's lucky 10,000."](https://imgs.xkcd.com/comics/ten_thousand.png)

Source: _[xkcd, May 2012](https://xkcd.com/1053/)_
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Twitter handle][]][Twitter badge]

Flutter is Google's SDK for crafting beautiful, fast user experiences for
mobile, web and desktop from a single codebase. Flutter works with existing
mobile, web, and desktop from a single codebase. Flutter works with existing
code, is used by developers and organizations around the world, and is free
and open source.

Expand All @@ -30,17 +30,17 @@ extensible and open development model.
We want to enable designers to deliver their full creative vision without being
forced to water it down due to limitations of the underlying framework.
Flutter's [layered architecture] gives you control over every pixel on the
screen, and its powerful compositing capabilities let you overlay and animate
graphics, video, text and controls without limitation. Flutter includes a full
screen and its powerful compositing capabilities let you overlay and animate
graphics, video, text, and controls without limitation. Flutter includes a full
[set of widgets][widget catalog] that deliver pixel-perfect experiences on both
iOS and Android.

![Reflectly hero image][Reflectly hero image]

### Fast results

Flutter is fast. It's powered by the same hardware-accelerated [Skia] 2D
graphics library that underpins Chrome and Android. We architected Flutter to
Flutter is fast. It's powered by the same hardware-accelerated 2D graphics
library that underpins Chome and Android: [Skia]. We architected Flutter to
support glitch-free, jank-free graphics at the native speed of your device.
Flutter code is powered by the world-class [Dart platform], which enables
compilation to 32-bit and 64-bit ARM machine code for iOS and Android, as well
Expand All @@ -57,13 +57,13 @@ and see the results instantly without restarting your app or losing its state.

### Extensible and open model

Flutter works with any development tool (or none at all), but includes editor
Flutter works with any development tool (or none at all) but includes editor
plug-ins for both [Visual Studio Code] and [IntelliJ / Android Studio]. Flutter
provides [thousands of packages][Flutter packages] to speed your development,
regardless of your target platform. And accessing other native code is easy,
with support for both [FFI] and [platform-specific APIs][platform channels].

Flutter is a fully open source project, and we welcome contributions.
Flutter is a fully open-source project, and we welcome contributions.
Information on how to get started can be found at our
[contributor guide](CONTRIBUTING.md).

Expand Down
4 changes: 2 additions & 2 deletions dev/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
This directory contains tools and resources that the Flutter team uses
during development of the framework. The tools in this directory
during the development of the framework. The tools in this directory
should not be necessary for developing Flutter applications, though of
course they may be interesting if you are curious.
course, they may be interesting if you are curious.

The tests in this directory are run in the `framework_tests_misc-*`
shards.
4 changes: 2 additions & 2 deletions dev/automated_tests/flutter_test/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The files in this directory are used as part of tests in the
The files in this directory are used as part of the tests in the
`flutter_tools` package. Some are here because here these tests need a
`pubspec.yaml` that references the flutter framework (which is
intentionally not true of the `flutter_tools` package). Others are
here mostly out of peer pressure.
here mostly out of peer pressure.
2 changes: 1 addition & 1 deletion dev/benchmarks/complex_layout/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ To measure startup time on a device:
flutter run --profile --trace-startup
```

Results should be in the logs.
The results should be in the logs.

Additional results should be in the file `build/start_up_info.json`.
37 changes: 32 additions & 5 deletions dev/benchmarks/macrobenchmarks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,33 @@ Performance benchmarks use either flutter drive or the web benchmark harness.

## Mobile benchmarks

### Cull opacity benchmark

To run the cull opacity benchmark on a device:

```
flutter drive --profile test_driver/cull_opacity_perf.dart
```

Results should be in the file `build/cull_opacity_perf.timeline_summary.json`.

More detailed logs should be in `build/cull_opacity_perf.timeline.json`.

### Cubic bezier benchmark

To run the cubic-bezier benchmark on a device:

```
flutter drive --profile test_driver/cubic_bezier_perf.dart
```

Results should be in the file `build/cubic_bezier_perf.timeline_summary.json`.

More detailed logs should be in `build/cubic_bezier_perf.timeline.json`.

### Backdrop filter benchmark

To run the backdrop filter benchmark on a device:
To run a mobile benchmark on a device:

```
Expand All @@ -30,7 +57,7 @@ The key `[test_name]` can be:

## Web benchmarks

Web benchmarks are compiled from the same entrypoint in `lib/web_benchmarks.dart`.
Web benchmarks are compiled from the same entry point in `lib/web_benchmarks.dart`.

### How to write a web benchmark

Expand All @@ -39,13 +66,13 @@ as an example.

Choose one of the two benchmark types:

* A "raw benchmark" records performance metrics from direct interactions with
- A "raw benchmark" records performance metrics from direct interactions with
`dart:ui` with no framework. This kind of benchmark is good for benchmarking
low-level engine primitives, such as layer, picture, and semantics performance.
* A "widget benchmark" records performance metrics using a widget. This kind of
- A "widget benchmark" records performance metrics using a widget. This kind of
benchmark is good for measuring the performance of widgets, often together with
engine work that widget-under-test incurs.
* A "widget build benchmark" records the cost of building a widget from nothing.
- A "widget build benchmark" records the cost of building a widget from nothing.
This is different from the "widget benchmark" because typically the latter
only performs incremental UI updates, such as an animation. In contrast, this
benchmark pumps an empty frame to clear all previously built widgets and
Expand Down Expand Up @@ -83,7 +110,7 @@ flutter run --profile -d web-server lib/web_benchmarks.dart
flutter run --dart-define=FLUTTER_WEB_USE_SKIA=true --profile -d web-server lib/web_benchmarks.dart
```

You can also run all benchmarks exactly like the devicelab runs them:
You can also run all benchmarks exactly as the devicelab runs them:

```
cd dev/devicelab
Expand Down
2 changes: 1 addition & 1 deletion dev/benchmarks/platform_views_layout/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ To measure startup time on a device:
flutter run --profile --trace-startup
```

Results should be in the logs.
The results should be in the logs.

Additional results should be in the file `build/start_up_info.json`.
4 changes: 2 additions & 2 deletions dev/benchmarks/test_apps/stocks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ the tool is used to generate localizations for this app.

## Icon

Icon was created using Android Asset Studio:
The icon was created using Android Asset Studio:
https://romannurik.github.io/AndroidAssetStudio/icons-launcher.html#foreground.type=image&foreground.space.trim=0&foreground.space.pad=0&foreColor=607d8b%2C0&crop=0&backgroundShape=square&backColor=fff%2C100&effects=none

From this clipart:
https://openclipart.org/detail/30403/tango-go-up
Which is public domain.
Which is in the public domain.
30 changes: 15 additions & 15 deletions dev/bots/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ This directory exists to support building Flutter on our build infrastructure.

The results of such builds are viewable at:
* https://cirrus-ci.com/github/flutter/flutter/master
- Testing done on PRs and submitted changes on GitHub.
- Testing is done on PRs and submitted changes on GitHub.
* https://ci.chromium.org/p/flutter/
- Additional testing and processing done after changes are submitted.
- Additional testing and processing are done after changes are submitted.

The LUCI infra requires permissions to retrigger or schedule builds. Contact
@kf6gpe or another Google member of the Flutter team if you need to do that.
Expand All @@ -29,7 +29,7 @@ machines and what kind are managed internally by Google. Contact @kf6gpe or
another Google member of the Flutter team if you suspect changes are needed
there. Both of these technologies are highly specific to the [LUCI](https://github.com/luci)
project, which is the successor to Chromium's infra. We're just borrowing some
of their infrastructure.
of their infrastructures.

### Prerequisites

Expand All @@ -39,17 +39,17 @@ To work on this infrastructure you will need:
- Python package installer: `sudo apt-get install python-pip`
- Python coverage package (only needed for `training_simulation`): `sudo pip install coverage`

To run prepare_package.dart locally:
To run `prepare_package.dart` locally:

- Make sure the depot_tools is in your PATH. If you're on Windows, you also need
an environment variable called DEPOT_TOOLS with the path to depot_tools as value.
- Make sure the `depot_tools` is in your `PATH`. If you're on Windows, you also need
an environment variable called `DEPOT_TOOLS` with the path to `depot_tools` as value.
- Run `gsutil.py config` (or `python %DEPOT_TOOLS%\gsutil.py` on Windows) to
authenticate with your auth token.
- Create a local temp directory. `cd` into it.
- Run `dart [path to your normal Flutter repo]/dev/bots/prepare_package.dart
--temp_dir=. --revision=[revision to package] --branch=[branch to deploy to]
--publish`.
- If you're running into gsutil permission issues, check with @Hixie to make sure
- If you're running into `gsutil` permission issues, check with @Hixie to make sure
you have the right push permissions.

### Getting the code
Expand Down Expand Up @@ -81,22 +81,22 @@ and

Recipes are just Python with some limitations on what can be imported. They are
[documented](https://github.com/luci/recipes-py/blob/master/doc/user_guide.md)
by the [luci/recipes-py github project](https://github.com/luci/recipes-py).
by the [luci/recipes-py GitHub project](https://github.com/luci/recipes-py).

The typical cycle for editing a recipe is:

1. Checkout the recipes project using `git clone https://flutter.googlesource.com/recipes`.
1. Check out the recipes project using `git clone https://flutter.googlesource.com/recipes`.
2. Make your edits (probably to files in
`//recipes/recipes`).
3. Update the tests. Run `recipes.py test train` to update
existing expected output to match the new output. Verify completely new test
the existing expected output to match the new output. Verify completely new test
cases by altering the `GenTests` method of the recipe. The recipe is required
to have 100% test coverage.
4. Run `led get-builder 'luci.flutter.prod:BUILDER_NAME' | led edit -p 'revision="GIT_HASH"' | led edit-recipe-bundle | led launch`, where `BUILDER_NAME` is the builder name (e.g. `Linux Engine`), and
`GIT_HASH` is the hash to build (which is important for the engine but not
for the framework).
5. To submit a CL, you need a local branch first (`git checkout -b [some branch name]`).
6. Upload the patch (`git commit`, `git cl upload`) and send it to someone in
6. Upload the patch (`git commit`, `git cl upload`), and send it to someone in
the `OWNERS` file for review.

### The infra config repository
Expand All @@ -112,7 +112,7 @@ schema that describes available properties.

### Future Directions

We would like to host our own recipes instead of storing them in
We would like to host our recipes instead of storing them in
[build](https://chromium.googlesource.com/chromium/tools/build.git/+/master/scripts/slave/recipes/flutter).
Support for [cross-repository
recipes](https://github.com/luci/recipes-py/blob/master/doc/cross_repo.md) is
Expand All @@ -123,7 +123,7 @@ tried, but it's not quite ready.
### Android Tools

The Android SDK and NDK used by Flutter's Chrome infra bots are stored in Google
Cloud. During the build a bot runs the `download_android_tools.py` script that
Cloud. During the build, a bot runs the `download_android_tools.py` script that
downloads the required version of the Android SDK into `dev/bots/android_tools`.

To check which components are currently installed, download the current SDK
Expand Down Expand Up @@ -216,8 +216,8 @@ want to do, run:
$ dart ./unpublish_package.dart --confirm --temp_dir=/tmp/foo --revision d444a455de87a2e40b7f576dc12ffd9ab82fd491
```

and it will actually perform the actions. You will of course need to have access
to the cloud storage server and have gsutil installed in order to perform this
and it will perform the actions. You will of course need to have access
to the cloud storage server and have `gsutil` installed to perform this
operation. Only runs on Linux or macOS systems.

See `dart ./unpublish_package.dart --help` for more details.
Expand Down
2 changes: 1 addition & 1 deletion dev/ci/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ to manually build and push the Docker image locally.

NOTE: there are some factors external to the actual `Dockerfile` that would
necessitate rebuilding the Docker image, such as upstream code changes, (Linux
distribution) repository updates, or a file that gets `COPY`ied into the image
distribution) repository updates or a file that gets `COPY`ied into the image
changing. In this case, a trivial `Dockerfile` change (such as a comment)
would invalidate the cache and trigger a rebuild.
4 changes: 2 additions & 2 deletions dev/ci/docker_linux/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
This directory includes scripts to build the docker container image used for
building flutter/flutter in our CI system (currently [Cirrus](cirrus-ci.org)).

In order to run the scripts, you have to setup `docker` and `gcloud`. Please
refer to the [internal flutter team doc](go/flutter-team) for how to setup in a
To run the scripts, you have to set up `docker` and `gcloud`. Please
refer to the [internal flutter team doc](go/flutter-team) for how to set up in a
Google internal environment.

To debug the image locally:
Expand Down
Loading

0 comments on commit d41b1fb

Please sign in to comment.