Skip to content

Commit d97a082

Browse files
Correct the grammar in the documents and restructure the formatting of all the markdowns (#1184)
* Fix * Replace `-` to `*` * Fix
1 parent 992674f commit d97a082

File tree

21 files changed

+150
-157
lines changed

21 files changed

+150
-157
lines changed

CODE_OF_CONDUCT.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Our Pledge
44

55
In the interest of fostering an open and welcoming environment, we as
6-
contributors and maintainers pledge to making participation in our project and
6+
contributors and maintainers pledge to participate in our project and
77
our community a harassment-free experience for everyone, regardless of age, body
88
size, disability, ethnicity, gender identity and expression, level of experience,
99
nationality, personal appearance, race, religion, or sexual identity and
@@ -23,12 +23,12 @@ include:
2323
Examples of unacceptable behavior by participants include:
2424

2525
* The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
26+
advances
2727
* Trolling, insulting/derogatory comments, and personal or political attacks
2828
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
29+
* Publishing others' private information, such as physical or electronic
3030
address, without explicit permission
31-
* Other conduct which could reasonably be considered inappropriate in a
31+
* Other conduct that could reasonably be considered inappropriate in a
3232
professional setting
3333

3434
## Our Responsibilities
@@ -45,8 +45,8 @@ threatening, offensive, or harmful.
4545

4646
## Scope
4747

48-
This Code of Conduct applies both within project spaces and in public spaces
49-
when an individual is representing the project or its community. Examples of
48+
This Code of Conduct applies both within and in public spaces
49+
when an individual represents the project or its community. Examples of
5050
representing a project or community include using an official project e-mail
5151
address, posting via an official social media account, or acting as an appointed
5252
representative at an online or offline event. Representation of a project may be
@@ -59,10 +59,10 @@ reported by contacting the project team at [[email protected]](mailto:hello@bas
5959
complaints will be reviewed and investigated and will result in a response that
6060
is deemed necessary and appropriate to the circumstances. The project team is
6161
obligated to maintain confidentiality with regard to the reporter of an incident.
62-
Further details of specific enforcement policies may be posted separately.
62+
You can post more details of specific enforcement policies separately.
6363

6464
Project maintainers who do not follow or enforce the Code of Conduct in good
65-
faith may face temporary or permanent repercussions as determined by other
65+
Faith may face temporary or permanent repercussions as determined by other
6666
members of the project's leadership.
6767

6868
## Attribution

CONTRIBUTING.md

+30-35
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,44 @@
1-
Contributing to the Flutter Permission handler plugin
2-
=============================================
1+
# Contributing to the Flutter Permission handler plugin
32

4-
What you will need
5-
------------------
3+
## What you will need
64

7-
* 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);
8-
* git (used for source version control, installation instruction can be found [here](https://git-scm.com/));
9-
* The Flutter SDK (installation instructions can be found [here](https://flutter.io/get-started/install/));
10-
* A personal GitHub account (if you don't have one, you can sign-up for free [here](https://github.com/))
5+
* 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);
6+
* git (used for source version control, installation instructions can be found [here](https://git-scm.com/));
7+
* The Flutter SDK (installation instructions can be found [here](https://flutter.io/get-started/install/));
8+
* A personal GitHub account (if you don't have one, you can sign up for free [here](https://github.com/))
119

12-
Setting up your development environment
13-
---------------------------------------
10+
## Setting up your development environment
1411

15-
* 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.
16-
* If you haven't configured your machine with an SSH key that's known to github, then
17-
follow [GitHub's directions](https://help.github.com/articles/generating-ssh-keys/)
18-
to generate an SSH key.
19-
* Clone your forked repo on your local development machine: `git clone [email protected]:<your_name_here>/flutter-permission-handler.git`
20-
* Change into the `flutter-permission-handler` directory: `cd flutter-permission-handler`
21-
* Add an upstream to the original repo, so that fetch from the master repository and not your clone: `git remote add upstream [email protected]:Baseflow/flutter-permission-handler.git`
12+
* 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.
13+
* If you haven't configured your machine with an SSH key that's known to GitHub, then
14+
follow [GitHub's directions](https://help.github.com/articles/generating-ssh-keys/)
15+
to generate an SSH key.
16+
* Clone your forked repo on your local development machine: `git clone [email protected]:<your_name_here>/flutter-permission-handler.git`
17+
* Change into the `flutter-permission-handler` directory: `cd flutter-permission-handler`
18+
* Add an upstream to the original repo, so that fetches from the master repository and not your clone: `git remote add upstream [email protected]:Baseflow/flutter-permission-handler.git`
2219

23-
Running the example project
24-
---------------------------
20+
## Running the example project
2521

26-
* Change into the example directory: `cd example`
27-
* Run the App: `flutter run`
22+
* Change into the example directory: `cd example`
23+
* Run the App: `flutter run`
2824

29-
Contribute
30-
----------
25+
## Contribute
3126

3227
We really appreciate contributions via GitHub pull requests. To contribute take the following steps:
3328

34-
* Make sure you are up to date with the latest code on the master:
35-
* `git fetch upstream`
36-
* `git checkout upstream/develop -b <name_of_your_branch>`
37-
* Apply your changes
38-
* Verify your changes and fix potential warnings/ errors:
39-
* Check formatting: `flutter format .`
40-
* Run static analyses: `flutter analyze`
41-
* Run unit-tests: `flutter test`
42-
* Commit your changes: `git commit -am "<your informative commit message>"`
43-
* Push changes to your fork: `git push origin <name_of_your_branch>`
29+
* Make sure you are up to date with the latest code on the master:
30+
* `git fetch upstream`
31+
* `git checkout upstream/develop -b <name_of_your_branch>`
32+
* Apply your changes
33+
* Verify your changes and fix potential warnings/ errors:
34+
* Check formatting: `flutter format .`
35+
* Run static analyses: `flutter analyze`
36+
* Run unit-tests: `flutter test`
37+
* Commit your changes: `git commit -am "<your informative commit message>"`
38+
* Push changes to your fork: `git push origin <name_of_your_branch>`
4439

4540
Send us your pull request:
4641

47-
* Go to `https://github.com/Baseflow/flutter-permission-handler` and click the "Compare & pull request" button.
42+
* Go to `https://github.com/Baseflow/flutter-permission-handler` and click the "Compare & pull request" button.
4843

49-
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.
44+
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.

0 commit comments

Comments
 (0)