|
7
|
1 # [jQuery UI](http://jqueryui.com/) - Interactions and Widgets for the web
|
|
|
2
|
|
|
3 jQuery UI is a curated set of user interface interactions, effects, widgets, and themes built on top of jQuery. Whether you're building highly interactive web applications, or you just need to add a date picker to a form control, jQuery UI is the perfect choice.
|
|
|
4
|
|
|
5 If you want to use jQuery UI, go to [jqueryui.com](http://jqueryui.com) to get started, [jqueryui.com/demos/](http://jqueryui.com/demos/) for demos, [api.jqueryui.com](http://api.jqueryui.com/) for API documentation, or the [Using jQuery UI Forum](http://forum.jquery.com/using-jquery-ui) for discussions and questions.
|
|
|
6
|
|
|
7 If you want to report a bug/issue, please visit [bugs.jqueryui.com](http://bugs.jqueryui.com).
|
|
|
8
|
|
|
9 If you are interested in helping develop jQuery UI, you are in the right place.
|
|
|
10 To discuss development with team members and the community, visit the [Developing jQuery UI Forum](http://forum.jquery.com/developing-jquery-ui) or [#jqueryui-dev on irc.freenode.net](http://irc.jquery.org/).
|
|
|
11
|
|
|
12
|
|
|
13 ## For contributors
|
|
|
14
|
|
|
15 If you want to help and provide a patch for a bugfix or new feature, please take
|
|
|
16 a few minutes and look at [our Getting Involved guide](http://wiki.jqueryui.com/w/page/35263114/Getting-Involved).
|
|
|
17 In particular check out the [Coding standards](http://wiki.jqueryui.com/w/page/12137737/Coding-standards)
|
|
|
18 and [Commit Message Style Guide](http://wiki.jqueryui.com/w/page/25941597/Commit-Message-Style-Guide).
|
|
|
19
|
|
|
20 In general, fork the project, create a branch for a specific change and send a
|
|
|
21 pull request for that branch. Don't mix unrelated changes. You can use the commit
|
|
|
22 message as the description for the pull request.
|
|
|
23
|
|
|
24
|
|
|
25 ## Running the Unit Tests
|
|
|
26
|
|
|
27 Run the unit tests with a local server that supports PHP. No database is required. Pre-configured php local servers are available for Windows and Mac. Here are some options:
|
|
|
28
|
|
|
29 - Windows: [WAMP download](http://www.wampserver.com/en/)
|
|
|
30 - Mac: [MAMP download](http://www.mamp.info/en/index.html)
|
|
|
31 - Linux: [Setting up LAMP](https://www.linux.com/learn/tutorials/288158-easy-lamp-server-installation)
|
|
|
32 - [Mongoose (most platforms)](http://code.google.com/p/mongoose/)
|
|
|
33
|
|
|
34
|
|
|
35 ## Building jQuery UI
|
|
|
36
|
|
|
37 jQuery UI uses the [Grunt](http://github.com/gruntjs/grunt) build system.
|
|
|
38
|
|
|
39 To build jQuery UI, you must have [node.js](http://nodejs.org/) installed and then run the following commands:
|
|
|
40
|
|
|
41 ```sh
|
|
|
42
|
|
|
43 # Install the Grunt CLI
|
|
|
44 npm install -g grunt-cli
|
|
|
45
|
|
|
46 # Clone the jQuery UI git repo
|
|
|
47 git clone git://github.com/jquery/jquery-ui.git
|
|
|
48 cd jquery-ui
|
|
|
49
|
|
|
50 # Install the node module dependencies
|
|
|
51 npm install
|
|
|
52
|
|
|
53 # Run the build task
|
|
|
54 grunt build
|
|
|
55
|
|
|
56 # There are many other tasks that can be run through Grunt.
|
|
|
57 # For a list of all tasks:
|
|
|
58 grunt --help
|
|
|
59 ```
|
|
|
60
|
|
|
61
|
|
|
62 ## For committers
|
|
|
63
|
|
|
64 When looking at pull requests, first check for [proper commit messages](http://wiki.jqueryui.com/w/page/12137724/Bug-Fixing-Guide).
|
|
|
65
|
|
|
66 Do not merge pull requests directly through GitHub's interface.
|
|
|
67 Most pull requests are a single commit; cherry-picking will avoid creating a merge commit.
|
|
|
68 It's also common for contributors to make minor fixes in an additional one or two commits.
|
|
|
69 These should be squashed before landing in master.
|
|
|
70
|
|
|
71 **Make sure the author has a valid name and email address associated with the commit.**
|
|
|
72
|
|
|
73 Fetch the remote first:
|
|
|
74
|
|
|
75 git fetch [their-fork.git] [their-branch]
|
|
|
76
|
|
|
77 Then cherry-pick the commit(s):
|
|
|
78
|
|
|
79 git cherry-pick [sha-of-commit]
|
|
|
80
|
|
|
81 If you need to edit the commit message:
|
|
|
82
|
|
|
83 git cherry-pick -e [sha-of-commit]
|
|
|
84
|
|
|
85 If you need to edit the changes:
|
|
|
86
|
|
|
87 git cherry-pick -n [sha-of-commit]
|
|
|
88 # make changes
|
|
|
89 git commit --author="[author-name-and-email]"
|
|
|
90
|
|
|
91 If it should go to the stable branch, cherry-pick it to stable:
|
|
|
92
|
|
|
93 git checkout 1-8-stable
|
|
|
94 git cherry-pick -x [sha-of-commit-from-master]
|
|
|
95
|
|
|
96 *NOTE: Do not cherry-pick into 1-8-stable until you have pushed the commit from master upstream.*
|
