Skip to content
This repository was archived by the owner on Jan 4, 2021. It is now read-only.

Commit 6fde7ba

Browse files
author
Francois-Xavier Gentilhomme
committed
v1.0.9 Rendering improvements
1 parent f2cad93 commit 6fde7ba

25 files changed

+779
-811
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,34 @@
11
# Contributing to MyScriptJS
22

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.
44
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/).
55

6-
#### Adding new features
6+
## Code format
77

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
911

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.
1613

17-
#### Testing in other browsers
14+
## Adding features
1815

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.
2017

21-
## Style guide
18+
If you create a new object, you should first create a JS file associated to this new object.
2219

23-
Code
20+
## Testing
2421

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`.
2823

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.
3025

3126
## CLA
3227

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).
3629

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.
3731

3832
## License
3933

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).

bower.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "myscript",
3-
"version": "1.0.8",
3+
"version": "1.0.9",
44
"main": "./dist/myscript.js",
55
"description": "MyScriptJS is a free and open-source JavaScript library providing the easiest way to use MyScript Cloud handwriting recognition in your web app",
66
"keywords": [

0 commit comments

Comments
 (0)