Skip to content

Commit 002ecc3

Browse files
authored
chore: grammar and typos in .md files (NativeScript#9632)
1 parent 4832179 commit 002ecc3

File tree

7 files changed

+18
-18
lines changed

7 files changed

+18
-18
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ We love you and your PR's 🤗. Please follow our [contributing guide](https://g
5454

5555
## Other source repos
5656

57-
Outside of the source centralized in this repo, NativeScript consists of a few other source repos. Here are the major ones:
57+
Outside the source centralized in this repo, NativeScript consists of a few other source repos. Here are the major ones:
5858

5959
- **[iOS runtime](https://github.com/NativeScript/ns-v8ios-runtime)**
6060
- [![npm](https://img.shields.io/npm/dm/tns-ios.svg)](https://www.npmjs.com/package/@nativescript/ios)

apps/ui/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
***e2e tests execution***
22

33
1. Local setup
4-
- install appium and all requirments related to `nativescript-dev-appium` plugin usage
4+
- install appium and all requirements related to `nativescript-dev-appium` plugin usage
55
- download images:
66

77
```npm run load-images Emulator-Api23-Default "iPhone X 12"```
@@ -36,7 +36,7 @@
3636
- Run:
3737

3838
`npm run e2e-debug [android|ios]`
39-
run in separate console and don't kill it. This command will start appium server and driver and use the installed app on the device but it will not execute tests.
39+
run in separate console and don't kill it. This command will start appium server and driver and use the installed app on the device, but it will not execute tests.
4040
- Go to vs code debugging and use a config like:
4141

4242
```

tools/notes/CONTRIBUTING-webpack.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Before starting, make yourself familiar with the `@nativescript/webpack`'s [docu
2323
## Project Structure
2424

2525
The repository contains several ingredients:
26-
* `installer.js` - combination of postinstall scripts for adding or removing webpack configurations and necessary dependecies when installing the plugin.
26+
* `installer.js` - combination of postinstall scripts for adding or removing webpack configurations and necessary dependencies when installing the plugin.
2727
* `templates/` - webpack config templates for different types of projects - NativeScript with JavaScript, NativeScript with TypeScript and NativeScript Angular projects.
2828
* `plugins/` - several [Webpack plugins](https://webpack.js.org/concepts/plugins/) necessary for bundling NativeScript applications.
2929
* `snapshot/android/` - tools used with the `NativeScriptSnapshot` plugin for generating V8 Heap Snapshots.
@@ -164,7 +164,7 @@ git checkout release && git pull
164164
git merge --ff-only origin/master
165165
```
166166
*** Note: If there are commits in release branch which are not merged in master branch '-ff-merge' command will fail.
167-
In this case the commits should be merge firstly from release in master branch as explained in section 'Merge changes from release into master' and then repeat step 1.
167+
In this case the commits should be merged firstly from release in master branch as explained in section 'Merge changes from release into master' and then repeat step 1.
168168
169169
2. Execute `npm i` to install dependencies:
170170
```
@@ -233,7 +233,7 @@ git commit
233233
git push
234234
```
235235
236-
6. Create pull request. Replace replace env ${MERGE_BRANCH} with its value
236+
6. Create pull request. Replace env ${MERGE_BRANCH} with its value
237237
```
238238
curl -d '{"title": "chore: merge release in master","body": "chore: merge release in master","head": "merge-release-in-master","base": "master"}' -X POST https://api.github.com/repos/NativeScript/NativeScript/pulls -H "Authorization: token ${GIT_TOKEN}"
239239
```
@@ -244,4 +244,4 @@ git checkout origin/master tns-platform-declarations/package.json tns-core-modul
244244
git commit --amend
245245
git push --force-with-lease
246246
```
247-
This will require to repeat steps from 1 to 4, since we need to keep the branches with the same history
247+
This will require repeating steps from 1 to 4, since we need to keep the branches with the same history

tools/notes/CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,12 +94,12 @@ When you click on the button, you will be redirected to the report page. On the
9494

9595
> Note: Each item name consists of the application name, type of device and platform version: `pr-e2e-tests-[application-name]-[device-type]-[platform-version]`. Usually, the test applications, that are executed for PRs are part of NativeScript repository.
9696
97-
Based on the executed suite, one of the following or all of the following files will be generated: `mochawesome.html` | `index.html` | `unit-tests.log`. Some of the reports also might include `*.png`, `*.logs` or `[page source].xml` files that can help in understanding where is the problem.
97+
Based on the executed suite, one of the following or all of the following files will be generated: `mochawesome.html` | `index.html` | `unit-tests.log`. Some reports also might include `*.png`, `*.logs` or `[page source].xml` files that can help in understanding where is the problem.
9898

9999
For example:
100100
1. When you select the `index.html` page, an additional `TestNG Results` sidebar will be displayed. There you can find a list of all failures.
101101
2. When you select one of them, you will see on the right side all tests, that have been executed. The problematic ones will be coloured in red.
102-
3. If you click on one of them, detailed info or error log will be displayed. As we've mentioned above in some of the test reports, you will also find screenshots, that demonstrates the problem visually. Those images can be found below the info/ error log.
102+
3. If you click on one of them, detailed info or error log will be displayed. As we've mentioned above in some test reports, you will also find screenshots, that demonstrates the problem visually. Those images can be found below the info/ error log.
103103

104104
## <a name="commit-messages"></a> Commit Message Guidelines
105105

@@ -248,7 +248,7 @@ git checkout release
248248
git merge --ff-only origin/master
249249
```
250250
*** Note: If there are commits in release branch which are not merged in master branch '-ff-merge' command will fail.
251-
In this case the commits should be merge firstly from release in master branch as explained in section 'Merge changes from release into master' and then repeat step 1.
251+
In this case the commits should be merged firstly from release in master branch as explained in section 'Merge changes from release into master' and then repeat step 1.
252252

253253
2. Execute `npm i` to install dependencies:
254254
```
@@ -277,7 +277,7 @@ npm --no-git-tag-version version [major|minor|patch] -m "release: cut the %s rel
277277
cd ..
278278
```
279279
6. Set correct version of **tns-core-modules-widgets** in tns-core-modules/package.json.
280-
Usually tns-core-modules-widgets should already have been released and we need to set the official version.
280+
Usually tns-core-modules-widgets should already have been released, and we need to set the official version.
281281

282282
7. Create release-branch with change log
283283
```
@@ -333,7 +333,7 @@ git commit
333333
git push
334334
```
335335

336-
6. Create pull request. Replace replace env ${MERGE_BRANCH} with its value
336+
6. Create pull request. Replace env ${MERGE_BRANCH} with its value
337337
```
338338
curl -d '{"title": "chore: merge release in master","body": "chore: merge release in master","head": "merge-release-in-master","base": "master"}' -X POST https://api.github.com/repos/NativeScript/NativeScript/pulls -H "Authorization: token ${GIT_TOKEN}"
339339
```
@@ -344,4 +344,4 @@ git checkout origin/master tns-platform-declarations/package.json tns-core-modul
344344
git commit --amend
345345
git push --force-with-lease
346346
```
347-
This will require to repeat steps from 1 to 4, since we need to keep the branches with the same history
347+
This will require repeating steps from 1 to 4, since we need to keep the branches with the same history

tools/notes/CodingConvention.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ class Foo {
509509
```
510510

511511
## TypeScript optional parameters
512-
**Do not** use optional parameters in IMPLEMENTATION files. This is because the TS compiler generates additional array and populates its from the **arguments** object. Still, it is OK to use these in a definition file (as declarations ONLY).
512+
**Do not** use optional parameters in IMPLEMENTATION files. This is because the TS compiler generates additional array and populates it from the **arguments** object. Still, it is OK to use these in a definition file (as declarations ONLY).
513513

514514
*Right:*
515515
```TypeScript

tools/notes/DevelopmentWorkflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ You can do changes in the test app and `nativescript-core` and rely on HMR to re
5050

5151
## Running the `e2e` Test Apps
5252

53-
There are couple of application used for development and testing.
53+
There are a couple of application used for development and testing.
5454
The `ui-test-app` is the more frequently used for development and validation. It is an ordinary NativeScript app that logs the test results on the go.
5555

5656
After the [initial setup](#initial-setup) run the e2e apps with:

tools/notes/HandlingErrors.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The `tns-core-modules/trace` utility module provides a good way to streamline er
1010
Here are the guidelines how to use this when contributing to core-modules or creating your own plugins.
1111

1212
### Use `trace.write()`
13-
Use trace.write() with the appropriate type to log non critical errors.
13+
Use trace.write() with the appropriate type to log non-critical errors.
1414

1515
>Note: For the `error` message level all loggers will be notified unconditionally, for all other levels (`log`,`info`,`warn`), tracing should be enabled and the corresponding categories should be added.
1616
@@ -21,7 +21,7 @@ Use the `error()` when an error has occurred which compromises the stability of
2121

2222
After calling `trace.error()` consider just returning from the function you are currently in without completing.
2323

24-
There are cases when code execution jumps between native code (ex. Android/iOS SDKs) and JavaScript trough callbacks. In those cases it is most difficult to determine if an error (ex. expected argument is `undefined` or current state of components is invalid) is critical or not. Although, it seems that error is unrecoverable, it might be the case that the callback is called when the app has gone to the background or trough activity/window that is not longer visible. So just reporting the error with `write()` or `error()` is a good option in such cases.
24+
There are cases when code execution jumps between native code (ex. Android/iOS SDKs) and JavaScript trough callbacks. In those cases it is most difficult to determine if an error (ex. expected argument is `undefined` or current state of components is invalid) is critical or not. Although, it seems that error is unrecoverable, it might be the case that the callback is called when the app has gone to the background or trough activity/window that is no longer visible. So just reporting the error with `write()` or `error()` is a good option in such cases.
2525

2626

2727
## Throw the Error directly in code
@@ -31,6 +31,6 @@ Avoid throwing errors directly, especially in code that is not directly called f
3131
2. Obviously misused public APIs (ex. wrong arguments types) which developers will call directly.
3232

3333
## Clearing Legacy Code
34-
Not all the code in the `tns-core-modules` might conform to this guide as it might be written before some of the improvements of the trace modules (ex. `error()`). If you came across to such code you can always [give us a PR](CONTRIBUTING.md) referencing [this issue](https://github.com/NativeScript/NativeScript/issues/5914).
34+
Not all the code in the `tns-core-modules` might conform to this guide as it might be written before some improvements of the trace modules (ex. `error()`). If you came across to such code you can always [give us a PR](CONTRIBUTING.md) referencing [this issue](https://github.com/NativeScript/NativeScript/issues/5914).
3535

3636

0 commit comments

Comments
 (0)