Skip to content

Commit c66620e

Browse files
committed
docs: Update
1 parent 1166bee commit c66620e

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,15 @@ Third-party patches are essential for keeping nativescript-facebook plugin great
1010
git clone git@github.com:<your-username>/nativescript-facebook.git
1111

1212
* Make commits of logical units.
13-
* Make sure your commit messages are in the proper format.
13+
* Make sure your commit messages are in the proper format. We are strongly recommend to use [semantic commit messages](https://seesparkbox.com/foundry/semantic_commit_messages)
1414
* Add tests for your changes and make them pass. How to run tests you can find in [Testing section](#Testing)
1515
* Push your changes to a topic branch in your fork of the repository.
1616
* Submit a pull request to the **nativescript-facebook** repository.
1717

18-
## <a name='Testing'> Testing </a>
18+
## Testing
1919

2020
There are three main points in order to get nativescript-facebook e2e UI tests running locally on iOS 10 Simulator and Android api 23 Emulator. Before that if you want to take a look at the tests and make some changes find them located in `demo/e2e-tests` folder.
2121

22-
Note, that all commands below assume you have installed npm packages in /src and /demo folders (`$ npm i`) and you are using OS X in order to use both iOS Simulator and Android emulator.
23-
2422
* Install Appium. Test execution depends on [nativescript-dev-appium](https://github.com/NativeScript/nativescript-dev-appium) plugin which is added as dev dependency in `demo` app folder and first command satisfies its requirement to have appium installed.
2523

2624
$ npm install -g appium@1.6.3

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ NativeScript : Facebook SDK ![apple](https://cdn3.iconfinder.com/data/icons/pico
3535
- [Login Response](#login-response)
3636
- [Graph API Example](#graph-api-example)
3737
- [Release notes](#release-notes)
38+
- [FAQ](#faq)
39+
- [Contributing](#contributing)
3840
- [License](#license)
3941

4042
<!-- /TOC -->
@@ -468,5 +470,8 @@ This sample is part of the demo apps and can be observed [here](https://github.c
468470
## FAQ
469471
Check out our FAQ section [here](https://github.com/NativeScript/nativescript-facebook/wiki/FAQ).
470472
473+
## Contributing
474+
Check out our Contribution guide [here](https://github.com/NativeScript/nativescript-facebook/blob/master/CONTRIBUTING.md).
475+
471476
## License
472477
[Apache 2.0](https://github.com/NativeScript/nativescript-facebook/blob/master/LICENSE)

0 commit comments

Comments
 (0)