|
1
|
# How to contribute
|
|
2
|
|
|
3
|
Community made patches, localisations, bug reports and contributions are always welcome and are crucial to ensure FlexSlider remains the #1 responsive jQuery slideshow solution. :)
|
|
4
|
|
|
5
|
When contributing, please ensure you follow the guidelines below so that we can keep on top of things.
|
|
6
|
|
|
7
|
__Note:__
|
|
8
|
|
|
9
|
GitHub is for *bug reports and contributions only* - if you have a setup question, please be mindful of this and keep your question clear and concise, if you must post it to this repository.
|
|
10
|
|
|
11
|
If you are a WooThemes customer, use [WooThemes Support](http://support.woothemes.com). Our ninjas are on hand to assist with your set up query.
|
|
12
|
|
|
13
|
## Getting Started
|
|
14
|
|
|
15
|
* Make sure you have a [GitHub account](https://github.com/signup/free)
|
|
16
|
* Submit a ticket for your issue, assuming one does not already exist (please look over the currently open issues before creating a new issue).
|
|
17
|
* Clearly describe the issue including steps to reproduce when it is a bug.
|
|
18
|
* Make sure you fill in the earliest version that you know has the issue.
|
|
19
|
|
|
20
|
## Making Changes
|
|
21
|
|
|
22
|
* Fork the repository on GitHub.
|
|
23
|
* Make the changes to your forked repository.
|
|
24
|
* Ensure you use LF line endings - no crazy windows line endings. :)
|
|
25
|
* When committing, reference your issue (#1234) and include a note about the fix.
|
|
26
|
* Push the changes to your fork and submit a pull request on the **master** branch of the FlexSlider repository. Existing maintenance branches will be maintained of by FlexSlider developers.
|
|
27
|
* Please don't modify the changelog, this will be maintained by FlexSlider developers.
|
|
28
|
|
|
29
|
At this point you're waiting on us to merge your pull request. We'll review all pull requests, and make suggestions and changes if necessary.
|
|
30
|
|
|
31
|
# Additional Resources
|
|
32
|
|
|
33
|
* [General GitHub documentation](http://help.github.com/)
|
|
34
|
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
|
|
35
|
* [WooThemes Support](http://support.woothemes.com)
|
