Correct the grammar in the documents and restructure the formatting of all the markdowns (#1184)

* Fix

* Replace `-` to `*`

* Fix

CODE_OF_CONDUCT.md

@@ -3,7 +3,7 @@
 ## Our Pledge
 
 In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
+contributors and maintainers pledge to participate in our project and
 our community a harassment-free experience for everyone, regardless of age, body
 size, disability, ethnicity, gender identity and expression, level of experience,
 nationality, personal appearance, race, religion, or sexual identity and
@@ -23,12 +23,12 @@ include:
 Examples of unacceptable behavior by participants include:
 
 * The use of sexualized language or imagery and unwelcome sexual attention or
-advances
+  advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+* Publishing others' private information, such as physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+* Other conduct that could reasonably be considered inappropriate in a
   professional setting
 
 ## Our Responsibilities
@@ -45,8 +45,8 @@ threatening, offensive, or harmful.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
+This Code of Conduct applies both within and in public spaces
+when an individual represents the project or its community. Examples of
 representing a project or community include using an official project e-mail
 address, posting via an official social media account, or acting as an appointed
 representative at an online or offline event. Representation of a project may be
@@ -59,10 +59,10 @@ reported by contacting the project team at [hello@baseflow.com](mailto:hello@bas
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+You can post more details of specific enforcement policies separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
+Faith may face temporary or permanent repercussions as determined by other
 members of the project's leadership.
 
 ## Attribution

CONTRIBUTING.md

-Contributing to the Flutter Permission handler plugin
-=============================================
+# Contributing to the Flutter Permission handler plugin
 
-What you will need
-------------------
+## What you will need
 
- * A Linux, Mac OS X, or Windows machine (note: to run and compile iOS specific parts you'll need access to a Mac OS X machine);
- * git (used for source version control, installation instruction can be found [here](https://git-scm.com/));
- * The Flutter SDK (installation instructions can be found [here](https://flutter.io/get-started/install/));
- * A personal GitHub account (if you don't have one, you can sign-up for free [here](https://github.com/))
+* A Linux, Mac OS X, or Windows machine (note: to run and compile iOS-specific parts you'll need access to a Mac OS X machine);
+* git (used for source version control, installation instructions can be found [here](https://git-scm.com/));
+* The Flutter SDK (installation instructions can be found [here](https://flutter.io/get-started/install/));
+* A personal GitHub account (if you don't have one, you can sign up for free [here](https://github.com/))
 
-Setting up your development environment
----------------------------------------
+## Setting up your development environment
 
- * Fork `https://github.com/Baseflow/flutter-permission-handler` into your own GitHub account. If you already have a fork and moving to a new computer, make sure you update you fork.
- * If you haven't configured your machine with an SSH key that's known to github, then
+* Fork `https://github.com/Baseflow/flutter-permission-handler` into your own GitHub account. If you already have a fork and moving to a new computer, make sure you update your fork.
+* If you haven't configured your machine with an SSH key that's known to GitHub, then
   follow [GitHub's directions](https://help.github.com/articles/generating-ssh-keys/)
   to generate an SSH key.
- * Clone your forked repo on your local development machine: `git clone git@github.com:<your_name_here>/flutter-permission-handler.git`
- * Change into the `flutter-permission-handler` directory: `cd flutter-permission-handler`
- * Add an upstream to the original repo, so that fetch from the master repository and not your clone: `git remote add upstream git@github.com:Baseflow/flutter-permission-handler.git`
+* Clone your forked repo on your local development machine: `git clone git@github.com:<your_name_here>/flutter-permission-handler.git`
+* Change into the `flutter-permission-handler` directory: `cd flutter-permission-handler`
+* Add an upstream to the original repo, so that fetches from the master repository and not your clone: `git remote add upstream git@github.com:Baseflow/flutter-permission-handler.git`
 
-Running the example project
----------------------------
+## Running the example project
 
- * Change into the example directory: `cd example`
- * Run the App: `flutter run`
+* Change into the example directory: `cd example`
+* Run the App: `flutter run`
 
-Contribute
-----------
+## Contribute
 
 We really appreciate contributions via GitHub pull requests. To contribute take the following steps:
 
- * Make sure you are up to date with the latest code on the master: 
+* Make sure you are up to date with the latest code on the master:
   * `git fetch upstream`
   * `git checkout upstream/develop -b <name_of_your_branch>`
- * Apply your changes
- * Verify your changes and fix potential warnings/ errors:
+* Apply your changes
+* Verify your changes and fix potential warnings/ errors:
   * Check formatting: `flutter format .`
   * Run static analyses: `flutter analyze`
   * Run unit-tests: `flutter test`
- * Commit your changes: `git commit -am "<your informative commit message>"`
- * Push changes to your fork: `git push origin <name_of_your_branch>`
+* Commit your changes: `git commit -am "<your informative commit message>"`
+* Push changes to your fork: `git push origin <name_of_your_branch>`
 
 Send us your pull request:
 
- * Go to `https://github.com/Baseflow/flutter-permission-handler` and click the "Compare & pull request" button.
+* Go to `https://github.com/Baseflow/flutter-permission-handler` and click the "Compare & pull request" button.
 
- Please make sure you solved all warnings and errors reported by the static code analyses and that you fill in the full pull request template. Failing to do so will result in us asking you to fix it.
+Please make sure you solved all warnings and errors reported by the static code analyses and that you fill in the full pull request template. Failing to do so will result in us asking you to fix it.

permission_handler/README.md

@@ -11,7 +11,7 @@ See the [FAQ](#faq) section for more information on common questions when using
 
 ## Setup
 
-While the permissions are being requested during runtime, you'll still need to tell the OS which permissions your app might potentially use. That requires adding permission configuration to Android- and iOS-specific files.
+While the permissions are being requested during runtime, you'll still need to tell the OS which permissions your app might potentially use. That requires adding permission configuration to Android* and iOS-specific files.
 
 <details>
 <summary>Android</summary>

permission_handler/example/pubspec.yaml

@@ -29,4 +29,3 @@ flutter:
   assets:
     - res/images/baseflow_logo_def_light-02.png
     - res/images/poweredByBaseflowLogoLight@3x.png
-

permission_handler_android/CHANGELOG.md

@@ -45,12 +45,12 @@
 ## 10.3.5
 
 * Fixes a bug where `Permission.ScheduleExactAlarm` was not opening the settings
-screen.
+  screen.
 
 ## 10.3.4
 
 * Fixes a bug where the permission status would return 'permanently denied'
-instead of 'denied' when the user would dismiss the permission dialog.
+  instead of 'denied' when the user dismisses the permission dialog.
 
 ## 10.3.3
 
@@ -62,7 +62,7 @@ instead of 'denied' when the user would dismiss the permission dialog.
 
 ## 10.3.1
 
-* Fixes `java.lang.IllegalStateException: Reply already submitted` when checking status of Bluetooth service.
+* Fixes `java.lang.IllegalStateException: Reply already submitted` when checking the status of Bluetooth service.
 
 ## 10.3.0
 
@@ -70,7 +70,7 @@ instead of 'denied' when the user would dismiss the permission dialog.
 
 ## 10.2.3
 
-* Fixes missing POST_NOTIFICATIONS permission in Android example project.
+* Fix missing POST_NOTIFICATIONS permission in the Android example project.
 
 ## 10.2.2
 
@@ -90,7 +90,7 @@ instead of 'denied' when the user would dismiss the permission dialog.
 
 ## 10.0.0
 
- * __BREAKING CHANGE__: Updates Android `compileSdkVersion` to `33` to handle the new `POST_NOTIFICATIONS` permission.
+* **BREAKING CHANGE**: Updates Android `compileSdkVersion` to `33` to handle the new `POST_NOTIFICATIONS` permission.
   > When updating to version 10.0.0 make sure to update the `android/app/build.gradle` file and set the `compileSdkVersion` to `33`.
 
 ## 9.0.2+1

permission_handler_android/README.md

@@ -12,11 +12,11 @@ More detailed instructions on using the API can be found in the [README.md](../p
 
 ## Issues
 
-Please file any issues, bugs or feature requests as an issue on our [GitHub](https://github.com/Baseflow/flutter-permission-handler/issues) page. Commercial support is available, you can contact us at <hello@baseflow.com>.
+Please file any issues, bugs, or feature requests as an issue on our [GitHub](https://github.com/Baseflow/flutter-permission-handler/issues) page. Commercial support is available, you can contact us at <hello@baseflow.com>.
 
 ## Want to contribute
 
-If you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug or adding a cool new feature), please carefully review our [contribution guide](../CONTRIBUTING.md) and send us your [pull request](https://github.com/Baseflow/flutter-permission-handler/pulls).
+If you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug, or adding a cool new feature), please carefully review our [contribution guide](../CONTRIBUTING.md) and send us your [pull request](https://github.com/Baseflow/flutter-permission-handler/pulls).
 
 ## Author
 

permission_handler_apple/CHANGELOG.md

@@ -36,11 +36,11 @@
 
 ## 9.0.4
 
-* Adds flag inside `UserDefaults` to save whether locationAlways has already been requested and prevent further requests, which would be left unanswered by the system.
+* Adds flag inside `UserDefaults` to save whether `locationAlways` has already been requested and prevent further requests, which would be left unanswered by the system.
 
 ## 9.0.3
 
-* Ensures a request for `locationAlways` permission returns a result unblocking the permission request and preventing the `ERROR_ALREADY_REQUESTING_PERMISSIONS` error for subsequent permission request.
+* Ensures a request for `locationAlways` permission returns a result unblocking the permission request and preventing the `ERROR_ALREADY_REQUESTING_PERMISSIONS` error for subsequent permission requests.
 
 ## 9.0.2
 

permission_handler_apple/README.md

@@ -12,11 +12,11 @@ More detailed instructions on using the API can be found in the [README.md](../p
 
 ## Issues
 
-Please file any issues, bugs or feature requests as an issue on our [GitHub](https://github.com/Baseflow/flutter-permission-handler/issues) page. Commercial support is available, you can contact us at <hello@baseflow.com>.
+Please file any issues, bugs, or feature requests as an issue on our [GitHub](https://github.com/Baseflow/flutter-permission-handler/issues) page. Commercial support is available, you can contact us at <hello@baseflow.com>.
 
 ## Want to contribute
 
-If you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug or adding a cool new feature), please carefully review our [contribution guide](../CONTRIBUTING.md) and send us your [pull request](https://github.com/Baseflow/flutter-permission-handler/pulls).
+If you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug, or adding a cool new feature), please carefully review our [contribution guide](../CONTRIBUTING.md) and send us your [pull request](https://github.com/Baseflow/flutter-permission-handler/pulls).
 
 ## Author
 

permission_handler_platform_interface/CHANGELOG.md

@@ -18,7 +18,7 @@
 ## 3.11.4
 
 * Clarifies the documentation on requesting background location permission
-through `Permission.locationAlways` on Android 10+ (API 29+).
+  through `Permission.locationAlways` on Android 10+ (API 29+).
 
 ## 3.11.3
 
@@ -58,7 +58,7 @@ through `Permission.locationAlways` on Android 10+ (API 29+).
 
 ## 3.7.0
 
-* Adds support for the new Android 12 Bluetooth permissions: BLUETOOTH_SCAN, BLUETOOTH_ADVERTISE and BLUETOOTH_CONNECT.
+* Adds support for the new Android 12 Bluetooth permissions: BLUETOOTH_SCAN, BLUETOOTH_ADVERTISE, and BLUETOOTH_CONNECT.
 
 ## 3.6.2
 
@@ -71,7 +71,7 @@ through `Permission.locationAlways` on Android 10+ (API 29+).
 
 ## 3.6.0
 
-* Adds support for iOS Critical alerts and Android Access Notification Policy.
+* Adds support for iOS Critical Alerts and Android Access Notification Policy.
 
 ## 3.5.1
 
@@ -91,25 +91,25 @@ through `Permission.locationAlways` on Android 10+ (API 29+).
 
 ## 3.2.0
 
-* Adds support for manage external storage permission available on Android 10 and up.
+* Adds support for managing external storage permission available on Android 10 and up.
 
 ## 3.1.3
 
-* Implements the equality operator for `Permission` class;
-* Reverts the services status check for notification permission. Turns out implementation does not fit with idea's of permission_handler plugin.
+* Implements the equality operator for the `Permission` class;
+* Reverts the status of the services check for notification permission. Turns out the implementation does not fit with the ideas of the permission_handler plugin.
 
 ## 3.1.2
 
-* Allows checking serviceStatus for notification permission.
+* Allows checking service status for notification permission.
 
 ## 3.1.1
 
 * Fixes conversion issue where `PermissionStatus.denied` was not translated to the correct index.
-* Adds unit-tests to guard API against breaking changes.
+* Adds unit tests to guard API against breaking changes.
 
 ## 3.1.0
 
-* Adds support for bluetooth permissions. 
+* Adds support for Bluetooth permissions.
 
 ## 3.0.0+1
 
@@ -121,17 +121,17 @@ through `Permission.locationAlways` on Android 10+ (API 29+).
 
 ## 2.0.2
 
-* Adds support for the limited photos permission available on iOS 14 and up.
+* Adds support for the limited photo permission available on iOS 14 and up.
 
 ## 2.0.1
 
 * Updates to `platform_interface 1.0.2`
-* Fixes bug which allows requesting is the device has phone capabilities.
+* Fixes bug that allows requesting if the device has phone capabilities.
 
 ## 2.0.0
 
-- **BREAKING**: Creates a much more intuitive API using Dart's new extension methods ([#230](https://github.com/Baseflow/flutter-permission-handler/issues/230)). Big thank you to [@marcelgarus](https://github.com/marcelgarus) for the idea and doing all the grunt work.
+* **BREAKING**: Creates a much more intuitive API using Dart's new extension methods ([#230](https://github.com/Baseflow/flutter-permission-handler/issues/230)). Big thank you to [@marcelgarus](https://github.com/marcelgarus) for the idea and for doing all the grunt work.
 
 ## 1.0.0
 
-- Initial open-source release.
+* Initial open-source release.

permission_handler_platform_interface/README.md

@@ -18,11 +18,11 @@ default `PermissionHandlerPlatform` by calling
 
 # Issues
 
-Please file any issues, bugs or feature request as an issue on our [GitHub](https://github.com/Baseflow/flutter-permission-handler/issues) page.
+Please file any issues, bugs, or feature requests as an issue on our [GitHub](https://github.com/Baseflow/flutter-permission-handler/issues) page.
 
 # Want to contribute
 
-If you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug or adding a cool new feature), please carefully review our [contribution guide](../CONTRIBUTING.md) and send us your [pull request](https://github.com/Baseflow/flutter-permission-handler/pulls).
+If you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug, or adding a cool new feature), please carefully review our [contribution guide](../CONTRIBUTING.md) and send us your [pull request](https://github.com/Baseflow/flutter-permission-handler/pulls).
 
 ## Note on breaking changes
 
@@ -30,7 +30,7 @@ Strongly prefer non-breaking changes (such as adding a method to the interface)
 over breaking changes for this package.
 
 See https://flutter.dev/go/platform-interface-breaking-changes for a discussion
-on why a less-clean interface is preferable to a breaking change.
+on why a less clean interface is preferable to a breaking change.
 
 # Author
 

permission_handler_platform_interface/analysis_options.yaml

-
 include: package:flutter_lints/flutter.yaml
 
 analyzer:
   exclude:
     # Ignore generated files
-    - '**/*.g.dart'
-    - 'lib/src/generated/*.dart'
+    - "**/*.g.dart"
+    - "lib/src/generated/*.dart"
 linter:
   rules:
     - public_member_api_docs

permission_handler_web/README.md

@@ -12,11 +12,11 @@ More detailed instructions on using the API can be found in the [README.md](../p
 
 ## Issues
 
-Please file any issues, bugs or feature requests as an issue on our [GitHub](https://github.com/Baseflow/flutter-permission-handler/issues) page. Commercial support is available, you can contact us at <hello@baseflow.com>.
+Please file any issues, bugs, or feature requests as an issue on our [GitHub](https://github.com/Baseflow/flutter-permission-handler/issues) page. Commercial support is available, you can contact us at <hello@baseflow.com>.
 
 ## Want to contribute
 
-If you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug or adding a cool new feature), please carefully review our [contribution guide](../CONTRIBUTING.md) and send us your [pull request](https://github.com/Baseflow/flutter-permission-handler/pulls).
+If you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug, or adding a cool new feature), please carefully review our [contribution guide](../CONTRIBUTING.md) and send us your [pull request](https://github.com/Baseflow/flutter-permission-handler/pulls).
 
 ## Author
 

permission_handler_web/example/pubspec.yaml

@@ -2,7 +2,7 @@ name: permission_handler_web_example
 description: Demonstrates how to use the permission_handler_web plugin..
 
 environment:
-  sdk: '>=3.0.5 <4.0.0'
+  sdk: ">=3.0.5 <4.0.0"
 
 # Dependencies specify other packages that your package needs in order to work.
 # To automatically upgrade your package dependencies to the latest versions
@@ -38,7 +38,6 @@ dev_dependencies:
 
 # The following section is specific to Flutter packages.
 flutter:
-
   # The following line ensures that the Material Icons font is
   # included with your application, so that you can use the icons in
   # the material Icons class.

permission_handler_web/pubspec.yaml

@@ -4,7 +4,7 @@ version: 0.0.1
 homepage:
 
 environment:
-  sdk: '>=3.0.5 <4.0.0'
+  sdk: ">=3.0.5 <4.0.0"
   flutter: ">=3.3.0"
 
 dependencies:
@@ -27,7 +27,6 @@ dev_dependencies:
 
 # The following section is specific to Flutter packages.
 flutter:
-
   plugin:
     implements: permission_handler
     platforms:

permission_handler_windows/example/pubspec.yaml

@@ -31,4 +31,3 @@ flutter:
     - res/images/poweredByBaseflowLogoLight@3x.png
     - packages/baseflow_plugin_template/logo.png
     - packages/baseflow_plugin_template/poweredByBaseflow.png
-