Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 75 lines (48 sloc) 4.629 kb
9f51a5f @jaspermdegroot Added CONTRIBUTING.md to the repo
jaspermdegroot authored
1 ## Issues
2
69ff906 @jaspermdegroot Updating Contributing Guidelines - part 2
jaspermdegroot authored
3 If you encounter a bug in the framework you can report it on the issue tracker here on Github. Questions about how to use the framework or problems with your custom code can be posted on the [forum](https://forum.jquery.com/jquery-mobile).
4 The jQuery Mobile [ThemeRoller](https://github.com/jquery/web-jquery-mobile-theme-roller) and [Download Builder](https://github.com/jquery/jquery-mobile-builder) have their own repo where you can report issues.
64d5296 @jaspermdegroot Updated Contributing Guidelines
jaspermdegroot authored
5
69ff906 @jaspermdegroot Updating Contributing Guidelines - part 2
jaspermdegroot authored
6 Before opening a new issue please check if the same or a similar issue already has been reported. Tip: Besides the search tool of the issue tracker you can filter issues by label.
64d5296 @jaspermdegroot Updated Contributing Guidelines
jaspermdegroot authored
7
1c38f87 @jaspermdegroot Added "new issue" links to Contributing Guidelines
jaspermdegroot authored
8 When [submitting an issue](https://github.com/jquery/jquery-mobile/issues/new) include the following:
9f51a5f @jaspermdegroot Added CONTRIBUTING.md to the repo
jaspermdegroot authored
9
10 1. Issue description
64d5296 @jaspermdegroot Updated Contributing Guidelines
jaspermdegroot authored
11 2. Test page (see below)
9f51a5f @jaspermdegroot Added CONTRIBUTING.md to the repo
jaspermdegroot authored
12 3. Steps to reproduce
13 4. Expected outcome
14 5. Actual outcome
64d5296 @jaspermdegroot Updated Contributing Guidelines
jaspermdegroot authored
15 6. Platforms/browsers (including version) and devices tested
16 7. jQuery Mobile and jQuery core version used
9f51a5f @jaspermdegroot Added CONTRIBUTING.md to the repo
jaspermdegroot authored
17 8. Other relevant information, e.g. using PhoneGap
18
64d5296 @jaspermdegroot Updated Contributing Guidelines
jaspermdegroot authored
19 In the interest of creating more readable issues please include code snippets inside a triple backtick box appropriate for the JavaScript/HTML/CSS snippet you wish to discuss. More information is available at the [introduction page](http://github.github.com/github-flavored-markdown/) for github flavored markdown (see Syntax Highlighting).
20
21 ### Test page
22
23 It is IMPORTANT that you always provide a test page when submitting an issue!
24
25 * Why? - This ensures that we are looking at exactly the same thing when testing on our devices and that we know about all markup and code that is in play.
26
69ff906 @jaspermdegroot Updating Contributing Guidelines - part 2
jaspermdegroot authored
27 * What? - Keep the test page as simple as possible. Only include markup/code that is required to reproduce the issue.
28
5273c47 @jaspermdegroot updated JS Bin template to use core 1.8.2
jaspermdegroot authored
29 * How? - Use our [JS Bin template](http://jsbin.com/uzaret/edit) which uses latest code on branch "master". Copy the updated url when you are done editing.
64d5296 @jaspermdegroot Updated Contributing Guidelines
jaspermdegroot authored
30 * You will notice if the issue has been fixed already
31 * It enables us to edit your code if necessary
3d68f4f @forresst [docs] CONTRIBUTING : typo
forresst authored
32 * The test page won't disappear or change while we are looking into the issue
64d5296 @jaspermdegroot Updated Contributing Guidelines
jaspermdegroot authored
33 * We can test again after committing a fix for the issue
9f51a5f @jaspermdegroot Added CONTRIBUTING.md to the repo
jaspermdegroot authored
34
64d5296 @jaspermdegroot Updated Contributing Guidelines
jaspermdegroot authored
35 ## Feature Requests
36
37 If you have an idea for a new feature or a suggestion how to improve an existing feature, let us know!
38
1c38f87 @jaspermdegroot Added "new issue" links to Contributing Guidelines
jaspermdegroot authored
39 1. Open a [new issue](https://github.com/jquery/jquery-mobile/issues/new) to describe your request
64d5296 @jaspermdegroot Updated Contributing Guidelines
jaspermdegroot authored
40 2. Add a link to the issue on the Feature Requests [wiki page](https://github.com/jquery/jquery-mobile/wiki/Feature-Requests)
41
42 Please note that we will flag the issue as feature request and then close it. We check requests on regular base and when we decide to implement a feature we set a milestone and re-open the ticket.
9f51a5f @jaspermdegroot Added CONTRIBUTING.md to the repo
jaspermdegroot authored
43
44 ## Pull Requests
45
46 When submitting a pull request for review there are a few important steps you can take to ensure that it gets reviewed quickly and increase the chances that it will be merged (in order of descending importance):
47
64d5296 @jaspermdegroot Updated Contributing Guidelines
jaspermdegroot authored
48 1. Include tests (see [Testing](https://github.com/jquery/jquery-mobile/blob/master/README.md#testing))
9f51a5f @jaspermdegroot Added CONTRIBUTING.md to the repo
jaspermdegroot authored
49 2. Follow the [jQuery Core style guide](http://docs.jquery.com/JQuery_Core_Style_Guidelines)
50 3. Limit the scope to one Issue/Feature
51 4. Small focused commits, ideally less than 10 to 20 lines
52 5. Avoid merge commits (see Pro Git's [chapter on rebasing](http://git-scm.com/book/ch3-6.html), section [Rebasing](#rebasing) below)
53 6. Add the appropriate commit message (see below)
54
55 Taken together, the above reduces the effort that's required of the contributor reviewing your pull request.
56
57 ### Commit messages
58
59 Commit messages should include four components:
64d5296 @jaspermdegroot Updated Contributing Guidelines
jaspermdegroot authored
60
9f51a5f @jaspermdegroot Added CONTRIBUTING.md to the repo
jaspermdegroot authored
61 * The WHERE - a single word that categorizes and provides context for the commit and its message, followed by a colon (:). This is typically the name of the plugin being worked on, but sometimes might be something like Build: or Docs:
62 * The WHAT - a sufficient summary of the fix or change made (example: modified the foo to no longer bar), followed by a period (.)
63 * The WHY #Num - the ticket number with a #sign so Trac creates a hyperlink (example: #1234), followed by a hyphen/dash (-)
64 * The WHY Name - the name of the ticket. Notice this is different than summary of the fix. This is a short description of the issue (example: dialog: IE6 crashed when foo is set to bar)
65
66 Combined into one, here's a full example:
67
68 "Dialog: modified the foo to no longer bar. Fixed #1234 - dialog: IE6 crashed when foo is set to bar"
69 \WHERE/:\------------- WHAT -------------/.\ WHY #Num /-\---------------- WHY Name ----------------/
64d5296 @jaspermdegroot Updated Contributing Guidelines
jaspermdegroot authored
70
71
69ff906 @jaspermdegroot Updating Contributing Guidelines - part 2
jaspermdegroot authored
72 ------------------------------------------------------------
73
64d5296 @jaspermdegroot Updated Contributing Guidelines
jaspermdegroot authored
74 *Thank you for contributing to the jQuery Mobile project!*
Something went wrong with that request. Please try again.