Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 97 lines (58 sloc) 3.878 kB
0a1ab40 @scottgonzalez README: Added link to Trac.
scottgonzalez authored
1 # [jQuery UI](http://jqueryui.com/) - Interactions and Widgets for the web
23c5b94 @jzaefferer Adding README.md for Github to display something
jzaefferer authored
2
c4c90f3 @tjvantoll Update the project's description as well as fix a few spelling / gram…
tjvantoll authored
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.
23c5b94 @jzaefferer Adding README.md for Github to display something
jzaefferer authored
4
c4c90f3 @tjvantoll Update the project's description as well as fix a few spelling / gram…
tjvantoll authored
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.
23c5b94 @jzaefferer Adding README.md for Github to display something
jzaefferer authored
6
0a1ab40 @scottgonzalez README: Added link to Trac.
scottgonzalez authored
7 If you want to report a bug/issue, please visit [bugs.jqueryui.com](http://bugs.jqueryui.com).
8
135eb29 @scottgonzalez Updated readme.
scottgonzalez authored
9 If you are interested in helping develop jQuery UI, you are in the right place.
c4c90f3 @tjvantoll Update the project's description as well as fix a few spelling / gram…
tjvantoll authored
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/).
135eb29 @scottgonzalez Updated readme.
scottgonzalez authored
11
58a41e7 @jzaefferer Readme update: Some instructions for cherry-picking from pull requests
jzaefferer authored
12
0a1ab40 @scottgonzalez README: Added link to Trac.
scottgonzalez authored
13 ## For contributors
5912d36 @scottgonzalez Readme: Added more details about landing pull requests.
scottgonzalez authored
14
416bc6f @jzaefferer Readme: Add contributor instructions, for someone not looking at site…
jzaefferer authored
15 If you want to help and provide a patch for a bugfix or new feature, please take
135eb29 @scottgonzalez Updated readme.
scottgonzalez authored
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)
416bc6f @jzaefferer Readme: Add contributor instructions, for someone not looking at site…
jzaefferer authored
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
0a1ab40 @scottgonzalez README: Added link to Trac.
scottgonzalez authored
25 ## Running the Unit Tests
00086a8 @scottgonzalez Readme: Added notes about running unit tests and creating builds.
scottgonzalez authored
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
0a1ab40 @scottgonzalez README: Added link to Trac.
scottgonzalez authored
35 ## Building jQuery UI
00086a8 @scottgonzalez Readme: Added notes about running unit tests and creating builds.
scottgonzalez authored
36
cca2daa @scottgonzalez README: Updated build instructions.
scottgonzalez authored
37 jQuery UI uses the [Grunt](http://github.com/gruntjs/grunt) build system.
00086a8 @scottgonzalez Readme: Added notes about running unit tests and creating builds.
scottgonzalez authored
38
cca2daa @scottgonzalez README: Updated build instructions.
scottgonzalez authored
39 To build jQuery UI, you must have [node.js](http://nodejs.org/) installed and then run the following commands:
eccd622 @scottgonzalez Readme: More docs about grunt.
scottgonzalez authored
40
cca2daa @scottgonzalez README: Updated build instructions.
scottgonzalez authored
41 ```sh
eccd622 @scottgonzalez Readme: More docs about grunt.
scottgonzalez authored
42
cca2daa @scottgonzalez README: Updated build instructions.
scottgonzalez authored
43 # Install the Grunt CLI
44 npm install -g grunt-cli
00086a8 @scottgonzalez Readme: Added notes about running unit tests and creating builds.
scottgonzalez authored
45
cca2daa @scottgonzalez README: Updated build instructions.
scottgonzalez authored
46 # Clone the jQuery UI git repo
47 git clone git://github.com/jquery/jquery-ui.git
48 cd jquery-ui
eccd622 @scottgonzalez Readme: More docs about grunt.
scottgonzalez authored
49
cca2daa @scottgonzalez README: Updated build instructions.
scottgonzalez authored
50 # Install the node module dependencies
51 npm install
00086a8 @scottgonzalez Readme: Added notes about running unit tests and creating builds.
scottgonzalez authored
52
be9f2c1 @tjvantoll README: Update build instructions to use concat tasks (instead of build)
tjvantoll authored
53 # Run the concat task to concatenate files
54 grunt concat
00086a8 @scottgonzalez Readme: Added notes about running unit tests and creating builds.
scottgonzalez authored
55
cca2daa @scottgonzalez README: Updated build instructions.
scottgonzalez authored
56 # There are many other tasks that can be run through Grunt.
57 # For a list of all tasks:
58 grunt --help
59 ```
eccd622 @scottgonzalez Readme: More docs about grunt.
scottgonzalez authored
60
00086a8 @scottgonzalez Readme: Added notes about running unit tests and creating builds.
scottgonzalez authored
61
0a1ab40 @scottgonzalez README: Added link to Trac.
scottgonzalez authored
62 ## For committers
5912d36 @scottgonzalez Readme: Added more details about landing pull requests.
scottgonzalez authored
63
58a41e7 @jzaefferer Readme update: Some instructions for cherry-picking from pull requests
jzaefferer authored
64 When looking at pull requests, first check for [proper commit messages](http://wiki.jqueryui.com/w/page/12137724/Bug-Fixing-Guide).
65
135eb29 @scottgonzalez Updated readme.
scottgonzalez authored
66 Do not merge pull requests directly through GitHub's interface.
5912d36 @scottgonzalez Readme: Added more details about landing pull requests.
scottgonzalez authored
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.**
135eb29 @scottgonzalez Updated readme.
scottgonzalez authored
72
73 Fetch the remote first:
74
f2e45f5 @scottgonzalez README: 1-8-stable -> 1-10-stable.
scottgonzalez authored
75 git fetch [their-fork.git] [their-branch]
135eb29 @scottgonzalez Updated readme.
scottgonzalez authored
76
77 Then cherry-pick the commit(s):
58a41e7 @jzaefferer Readme update: Some instructions for cherry-picking from pull requests
jzaefferer authored
78
135eb29 @scottgonzalez Updated readme.
scottgonzalez authored
79 git cherry-pick [sha-of-commit]
58a41e7 @jzaefferer Readme update: Some instructions for cherry-picking from pull requests
jzaefferer authored
80
135eb29 @scottgonzalez Updated readme.
scottgonzalez authored
81 If you need to edit the commit message:
58a41e7 @jzaefferer Readme update: Some instructions for cherry-picking from pull requests
jzaefferer authored
82
f2e45f5 @scottgonzalez README: 1-8-stable -> 1-10-stable.
scottgonzalez authored
83 git cherry-pick -e [sha-of-commit]
58a41e7 @jzaefferer Readme update: Some instructions for cherry-picking from pull requests
jzaefferer authored
84
135eb29 @scottgonzalez Updated readme.
scottgonzalez authored
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
c4c90f3 @tjvantoll Update the project's description as well as fix a few spelling / gram…
tjvantoll authored
91 If it should go to the stable branch, cherry-pick it to stable:
58a41e7 @jzaefferer Readme update: Some instructions for cherry-picking from pull requests
jzaefferer authored
92
f2e45f5 @scottgonzalez README: 1-8-stable -> 1-10-stable.
scottgonzalez authored
93 git checkout 1-10-stable
94 git cherry-pick -x [sha-of-commit-from-master]
135eb29 @scottgonzalez Updated readme.
scottgonzalez authored
95
f2e45f5 @scottgonzalez README: 1-8-stable -> 1-10-stable.
scottgonzalez authored
96 *NOTE: Do not cherry-pick into 1-10-stable until you have pushed the commit from master upstream.*
Something went wrong with that request. Please try again.