|
1 | 1 | # Contributing to MyScriptJS |
2 | 2 |
|
3 | | -We welcome pull requests to MyScriptJS. If you'd like to new or larger feature, keep reading. |
| 3 | +We gladly welcome pull requests to MyScriptJS. If you would like to add or modify new or larger features, see the "Adding features" section. |
4 | 4 | If you have any questions, or want help solving a problem, feel free to stop by the [#MyScript forum](https://dev.myscript.com/support/forum/). |
5 | 5 |
|
6 | | -#### Adding new features |
| 6 | +## Code format |
7 | 7 |
|
8 | | -Functions are distributed into several JS files, each taking care of a specific phase of a Cloud based handwriting recognition (ink collection, networking, rendering, etc.). If the feature you want to add is similar to an existing function, add your contribution to that file. |
| 8 | +* each filename should be in camelCase |
| 9 | +* 4 spaces for indentation |
| 10 | +* 120 character-line length |
9 | 11 |
|
10 | | -If you create a new object, you should create a new file associated to this new object. File name should be the object name in smallcaps. |
11 | | - |
12 | | -## Testing |
13 | | - |
14 | | -Local testing can be using the Karma engine through Grunt. First, install all dependencies |
15 | | -`npm install` from the root folder of the project, then run `grunt test-unit`. |
| 12 | +In general, try to make your code blend in with the surrounding code. |
16 | 13 |
|
17 | | -#### Testing in other browsers |
| 14 | +## Adding features |
18 | 15 |
|
19 | | -MyScriptJS supports all major browsers. Unfortunately, it is hard to test new changes in many browsers. If you can, please test your changes in as many browsers as possible. |
| 16 | +Functions are distributed into several JS files, each taking care of a specific phase of a Cloud-based handwriting recognition process (ink collection, networking, rendering, etc.). If the feature you want to add is similar to an existing one, add your contribution to the corresponding file. |
20 | 17 |
|
21 | | -## Style guide |
| 18 | +If you create a new object, you should first create a JS file associated to this new object. |
22 | 19 |
|
23 | | -Code |
| 20 | +## Testing |
24 | 21 |
|
25 | | - - 4 spaces for indentation |
26 | | - - 120 character line length |
27 | | - - declare variables in the outermost scope that they are used |
| 22 | +Local testing can be done using the Karma engine through Grunt. First, install all dependencies `npm install` from the root folder of the project, then run `grunt test`. |
28 | 23 |
|
29 | | -In general, try to make your code blend in with the surrounding code. |
| 24 | +MyScriptJS supports all major browsers. Unfortunately, it is hard to test new changes so if you can, please test your changes in as many browsers as possible. |
30 | 25 |
|
31 | 26 | ## CLA |
32 | 27 |
|
33 | | -In order to contribute, you must first agree to the **Contributor License Agreement**, found [here](http://goo.gl/forms/YyzZ9VSvYG). |
34 | | - |
35 | | -Make sure you have read the article "[Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)" to understand the process of contributing. |
| 28 | +In order to contribute, you must first agree to the **Contributor License Agreement** available [here](http://goo.gl/forms/YyzZ9VSvYG). |
36 | 29 |
|
| 30 | +Make sure you read the article "[Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)" to understand the contributing process. |
37 | 31 |
|
38 | 32 | ## License |
39 | 33 |
|
40 | | -This library is licensed under the [Apache 2.0](http://opensource.org/licenses/Apache-2.0). |
41 | | - |
| 34 | +This library is licensed under the [Apache 2.0](http://opensource.org/licenses/Apache-2.0). |
0 commit comments