Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 91 lines (54 sloc) 3.312 kB
de45b67 @jzaefferer Improving README.md, eg. fixing links after misunderstanding Markdown
jzaefferer 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 ================================
3
de45b67 @jzaefferer Improving README.md, eg. fixing links after misunderstanding Markdown
jzaefferer authored
4 jQuery UI provides interactions like Drag and Drop and widgets like Autocomplete, Tabs and Slider and makes these as easy to use as jQuery itself.
23c5b94 @jzaefferer Adding README.md for Github to display something
jzaefferer authored
5
d29f819 @jzaefferer Fixing another typo in README
jzaefferer authored
6 If you want to use jQuery UI, go to [jqueryui.com](http://jqueryui.com) to get started. Or visit 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
7
135eb29 @scottgonzalez Updated readme.
scottgonzalez authored
8 If you are interested in helping develop jQuery UI, you are in the right place.
9 To discuss development with team members and the community, visit the [Developing jQuery UI Forum](http://forum.jquery.com/developing-jquery-ui) or in #jquery on irc.freednode.net.
10
58a41e7 @jzaefferer Readme update: Some instructions for cherry-picking from pull requests
jzaefferer authored
11
416bc6f @jzaefferer Readme: Add contributor instructions, for someone not looking at site…
jzaefferer authored
12 For contributors
13 ---
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
00086a8 @scottgonzalez Readme: Added notes about running unit tests and creating builds.
scottgonzalez authored
25 Running the Unit Tests
26 ---
27
28 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:
29
30 - Windows: [WAMP download](http://www.wampserver.com/en/)
31 - Mac: [MAMP download](http://www.mamp.info/en/index.html)
32 - Linux: [Setting up LAMP](https://www.linux.com/learn/tutorials/288158-easy-lamp-server-installation)
33 - [Mongoose (most platforms)](http://code.google.com/p/mongoose/)
34
35
36 Building jQuery UI
37 ---
38
39 jQuery UI uses the [grunt](http://github.com/cowboy/grunt) build system. Building jQuery UI requires node.js and a command line zip program.
40
41 Clone the jQuery UI git repo.
42
43 `git clone git://github.com/jquery/jquery-ui.git`
44 `cd jquery-ui`
45
46 Install node modules.
47
48 `npm install`
49
50 Run grunt.
51
52 `grunt build`
53
54
db20d68 @jasondavies Fix speling.
jasondavies authored
55 For committers
58a41e7 @jzaefferer Readme update: Some instructions for cherry-picking from pull requests
jzaefferer authored
56 ---
5912d36 @scottgonzalez Readme: Added more details about landing pull requests.
scottgonzalez authored
57
58a41e7 @jzaefferer Readme update: Some instructions for cherry-picking from pull requests
jzaefferer authored
58 When looking at pull requests, first check for [proper commit messages](http://wiki.jqueryui.com/w/page/12137724/Bug-Fixing-Guide).
59
135eb29 @scottgonzalez Updated readme.
scottgonzalez authored
60 Do not merge pull requests directly through GitHub's interface.
5912d36 @scottgonzalez Readme: Added more details about landing pull requests.
scottgonzalez authored
61 Most pull requests are a single commit; cherry-picking will avoid creating a merge commit.
62 It's also common for contributors to make minor fixes in an additional one or two commits.
63 These should be squashed before landing in master.
64
65 **Make sure the author has a valid name and email address associated with the commit.**
135eb29 @scottgonzalez Updated readme.
scottgonzalez authored
66
67 Fetch the remote first:
68
69 git fetch [their-fork.git] [their-branch]
70
71 Then cherry-pick the commit(s):
58a41e7 @jzaefferer Readme update: Some instructions for cherry-picking from pull requests
jzaefferer authored
72
135eb29 @scottgonzalez Updated readme.
scottgonzalez authored
73 git cherry-pick [sha-of-commit]
58a41e7 @jzaefferer Readme update: Some instructions for cherry-picking from pull requests
jzaefferer authored
74
135eb29 @scottgonzalez Updated readme.
scottgonzalez authored
75 If you need to edit the commit message:
58a41e7 @jzaefferer Readme update: Some instructions for cherry-picking from pull requests
jzaefferer authored
76
63b89b7 @rdworth README: Fixed code samples to be (markdown) indented properly with 4 …
rdworth authored
77 git cherry-pick -e [sha-of-commit]
58a41e7 @jzaefferer Readme update: Some instructions for cherry-picking from pull requests
jzaefferer authored
78
135eb29 @scottgonzalez Updated readme.
scottgonzalez authored
79 If you need to edit the changes:
80
81 git cherry-pick -n [sha-of-commit]
82 # make changes
83 git commit --author="[author-name-and-email]"
84
58a41e7 @jzaefferer Readme update: Some instructions for cherry-picking from pull requests
jzaefferer authored
85 If it should go to the stable brach, cherry-pick it to stable:
86
63b89b7 @rdworth README: Fixed code samples to be (markdown) indented properly with 4 …
rdworth authored
87 git checkout 1-8-stable
135eb29 @scottgonzalez Updated readme.
scottgonzalez authored
88 git cherry-pick -x [sha-of-commit-from-master]
89
90 *NOTE: Do not cherry-pick into 1-8-stable until you have pushed the commit from master upstream.*
Something went wrong with that request. Please try again.