89 lines
4.0 KiB
Markdown
89 lines
4.0 KiB
Markdown
|
## Contributing
|
||
|
|
|
||
|
|
The [issue tracker](https://github.com/OwlCarousel2/OwlCarousel2/issues) is the preferred channel for bug reports, feature requests, and submitting pull requests.
|
||
|
|
|
||
|
|
**Please do not use the issue tracker for personal support requests. Stack Overflow ([`owl-carousel`](https://stackoverflow.com/questions/tagged/owl-carousel)) is a better place to get help.**
|
||
|
|
|
||
|
|
### Bug reports
|
||
|
|
|
||
|
|
A bug is a **demonstrable, reproducible problem** that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks!
|
||
|
|
|
||
|
|
Guidelines for bug reports:
|
||
|
|
|
||
|
|
1. Use the GitHub issue search — check if the issue has already been reported.
|
||
|
|
|
||
|
|
2. Check if the issue has been fixed — try to reproduce it using the latest `develop` branch in the repository.
|
||
|
|
|
||
|
|
3. Isolate the problem - you NEED to provide a live example — ideally also create a reduced test case. This [CodePen](https://codepen.io/anon/pen/prvbMp), [JSFiddle](https://jsfiddle.net/h8x8bvn9/2/) and [JS Bin](https://jsbin.com/bojonaceve/2/edit?html,js,output) are helpful templates you can fork or clone.
|
||
|
|
|
||
|
|
Example:
|
||
|
|
|
||
|
|
> Short and descriptive example bug report title
|
||
|
|
>
|
||
|
|
> A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.
|
||
|
|
>
|
||
|
|
> 1. This is the first step
|
||
|
|
> 2. This is the second step
|
||
|
|
> 3. Further steps, etc.
|
||
|
|
>
|
||
|
|
> `<url>` - a link to the reduced test case
|
||
|
|
>
|
||
|
|
> Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).
|
||
|
|
|
||
|
|
### Feature requests
|
||
|
|
|
||
|
|
Feature requests are welcome, but please take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature.
|
||
|
|
|
||
|
|
To get approval for your feature request, please create an issue on the issue tracker with as much detail and context as possible. We'll take a look at it and then [hopefully] apply the "[approved for development](https://github.com/OwlCarousel2/OwlCarousel2/labels/approved%20for%20development)" tag so someone can get to work on it!
|
||
|
|
|
||
|
|
### Pull requests
|
||
|
|
|
||
|
|
Good pull requests are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
|
||
|
|
|
||
|
|
Adhering to the following process is the best way to get your work included in the project:
|
||
|
|
|
||
|
|
1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork, and configure the remotes:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
git clone https://github.com/<your-username>/OwlCarousel2.git
|
||
|
|
cd OwlCarousel2
|
||
|
|
git remote add upstream https://github.com/OwlCarousel2/OwlCarousel2.git
|
||
|
|
```
|
||
|
|
|
||
|
|
2. If you cloned a while ago, get the latest changes from upstream:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
git checkout develop
|
||
|
|
git pull [--rebase] upstream develop
|
||
|
|
```
|
||
|
|
|
||
|
|
3. Create a new topic branch (off the main project `develop` branch) to contain your feature, change, or fix:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
git checkout -b <topic-branch-name>
|
||
|
|
```
|
||
|
|
|
||
|
|
4. Build the distribution before committing to ensure your changes follow the coding standards and all build files are up to date.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
grunt dist
|
||
|
|
```
|
||
|
|
|
||
|
|
5. Commit your changes in logical chunks. Please adhere to these [guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). Use Git's [interactive rebase](https://help.github.com/articles/interactive-rebase) feature to tidy up your commits before making them public.
|
||
|
|
|
||
|
|
6. Locally merge (or rebase) the upstream development branch into your topic branch:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
git pull [--rebase] upstream develop
|
||
|
|
```
|
||
|
|
|
||
|
|
7. Push your topic branch up to your fork:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
git push origin <topic-branch-name>
|
||
|
|
```
|
||
|
|
|
||
|
|
8. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description against the `develop` branch.
|
||
|
|
|
||
|
|
**By submitting a patch, you agree to allow the project owner to license your work under the terms of the [MIT License](LICENSE).**
|