-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathHow to Contribute.txt
46 lines (31 loc) · 2.9 KB
/
How to Contribute.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
How to Contribute
Before committing your effort, please read "Terms of use.txt" first.
Visual Dynamics Software Ltd. is committed to develop reusable user interface controls based on this open source project
and deliver them to customers under commercial license. Please visit http://jcontrol-visualdynamics.cloudapp.net/
to ensure the controls or features do not exist in the commercial version before taking time to develop them.
Copyright of source code contributed to this project will be shared between you and Visual Dynamics Software Ltd.
These controls and features will be available to public under GPL license (http://opensource.org/licenses/GPL-3.0).
JavaScript Source code in this project requires "RequireJs" to work. A copy of require.js is included in the project
for your convenience. Please honour the license set forth by RequireJS (http://requirejs.org/).
All accompanying CSS files are generated by SASS (http://sass-lang.com/) which requires
Ruby (http://www.rubyinstaller.org/) to run.
To minimize JavaScript code, you may need nodeJs (http://nodejs.org/).
A MicroSoft ASP.NET MVC project is provided in the source as an example for using this library.
To run the sample project, you'd need MicroSoft Visual Studio v10.
A set of JavaScript unit tests is also included for quality assurance.
TestCore.html runs a set of QUnit tests for classes in "elements" and "observe" folder. If you modified any classes
in these two folders, please add unit tests for your modification in the corresponding test files. If you need to
add additional classes to these folders, please add unit test files for them and include your tests in coreTests.js
which is executed in TestCore.html.
TestJControl.html runs a set of QUnit tests for classes in "controls" folder. If you modified any classes in "controls"
folder, please add unit tests for your modification in the corresponding test files. If you need to add additional
classes to "controls" folder, please add unit test files for them and include your tests in controlTests.js
which is executed in TestJControl.html.
Before your contribution can be pulled in, both TestCore.html and TestJControl.html must pass in the following browsers:
Internet Explorer version 8, 9, 10, 11, Chrome (>= 29.0.1547.57), Firefox (>= 23.0.1), Safari (>= 5.1.7),
and Opera (>= 18.0.1284.63). Please run all tests in all supported browsers before making a pull request.
For general programming style, please read: http://oojscontrols.blogspot.ca/2013/11/oo-programming-with-javascript.html.
Any new classes contributed to this project are expected to follow the same coding style. Comments in code should be
limited to documentation (YUI Doc style, http://yui.github.io/yuidoc/syntax/) and licensing information. Any extra
comments in code are not encouraged since we follow the simple rule: "Readable code does not need comments."
For any questions, please email: jp.chen.jianping@gmail.com.