|
1 | | -# Issue Guidelines |
| 1 | +Please follow these pull request guidelines: |
2 | 2 |
|
3 | | -The issues tracker should only be used for **bugs** or **feature requests**. |
4 | | - |
5 | | -Please post **support requests** and **general discussions** about this project to the [support forum](https://groups.google.com/d/forum/jquery-fileupload). |
6 | | - |
7 | | -## Bugs |
8 | | - |
9 | | -Please follow these guidelines before reporting a bug: |
10 | | - |
11 | | -1. **Update to the latest version** — Check if you can reproduce the issue with the latest version from the `master` branch. |
12 | | - |
13 | | -2. **Use the GitHub issue search** — check if the issue has already been reported. If it has been, please comment on the existing issue. |
14 | | - |
15 | | -3. **Isolate the demonstrable problem** — Try to reproduce the problem with the [Demo](https://blueimp.github.io/jQuery-File-Upload/) or with a reduced test case that includes the least amount of code necessary to reproduce the problem. |
16 | | - |
17 | | -4. **Provide a means to reproduce the problem** — Please provide as much details as possible, e.g. server information, browser and operating system versions, steps to reproduce the problem. If possible, provide a link to your reduced test case, e.g. via [JSFiddle](http://jsfiddle.net/). |
18 | | - |
19 | | - |
20 | | -## Feature requests |
21 | | - |
22 | | -Please follow the bug guidelines above for feature requests, i.e. update to the latest version and search for exising issues before posting a new request. |
23 | | - |
24 | | -Generally, feature requests might be accepted if the implementation would benefit a broader use case or the project could be considered incomplete without that feature. |
25 | | - |
26 | | -If you need help integrating this project into another framework, please post your request to the [support forum](https://groups.google.com/d/forum/jquery-fileupload). |
27 | | - |
28 | | -## Pull requests |
29 | | - |
30 | | -[Pull requests](https://help.github.com/articles/using-pull-requests) are welcome and the preferred way of accepting code contributions. |
| 3 | +1. Update your fork to the latest upstream version. |
31 | 4 |
|
32 | | -However, if you add a server-side upload handler implementation for another framework, please continue to maintain this version in your own fork without sending a pull request. You are welcome to add a link and possibly documentation about your implementation to the [Wiki](https://github.com/blueimp/jQuery-File-Upload/wiki). |
| 5 | +2. Follow the coding conventions of the original source files (indentation, spaces, brackets layout). |
33 | 6 |
|
34 | | -Please follow these guidelines before sending a pull request: |
| 7 | +3. Code changes must pass JSHint validation with the `.jshintrc` settings of this project. |
35 | 8 |
|
36 | | -1. Update your fork to the latest upstream version. |
| 9 | +4. Code changes must pass the QUnit tests defined in the `test` folder. |
37 | 10 |
|
38 | | -2. Follow the coding conventions of the original repository. Changes to one of the JavaScript source files are required to pass the [JSHint](http://www.jshint.com/) validation tool. |
| 11 | +5. New features should be covered by accompanying QUnit tests. |
39 | 12 |
|
40 | | -3. Keep your commits as atomar as possible, i.e. create a new commit for every single bug fix or feature added. |
| 13 | +6. Keep your commits as atomar as possible, i.e. create a new commit for every single bug fix or feature added. |
41 | 14 |
|
42 | | -4. Always add meaningfull commit messages. |
| 15 | +7. Always add meaningful commit messages. |
0 commit comments