Welcome Contributors
Contributions to Slick Carousel are welcome! Whether you’re fixing bugs, adding features, or improving documentation, your help is appreciated.Please review these guidelines before submitting pull requests or filing issues.
Submitting Issues
Bug Reports
Before submitting a bug report:Create a test case
Fork this JSFiddle as a baseline: https://jsfiddle.net/o1yehw0g/1/Your test case must:
- Clearly demonstrate the bug or issue
- Contain the bare minimum HTML, CSS, and JavaScript required
- Use non-minified assets (we cannot debug
.min.jsfiles) - Be a reduced test case, not a link to your production site
Issue Template
When creating an issue, use this format:Getting Support
GitHub Issues is not for support questions. Use these resources instead:
Where to Ask Questions
Where to Ask Questions
If you’re having problems getting Slick to work or can’t figure something out:
- Stack Overflow: stackoverflow.com/questions/tagged/slick
- Search existing questions
- Ask new questions with the
slicktag
- Gitter Chat: gitter.im/kenwheeler/slick
- Real-time community discussion
- Share code and get quick feedback
- Troubleshooting Guide: View common issues
- Check solutions to frequent problems
Feature Requests
If you would like to request or propose a feature:Discuss features on r/slickcarousel
Gitter
Chat with the community
Feature requests are welcome, but please discuss them in the community forums before opening a GitHub issue.
Pull Requests
Contributions are welcome! Please be prepared to edit your pull request based on feedback.
Before Submitting a Pull Request
Discuss major changes
For significant features or changes:
- Open an issue first to discuss your proposal
- Get feedback from maintainers
- Ensure the feature aligns with project goals
Create a working test case
Provide a jsFiddle demonstrating your change working with:
- Every mode that Slick supports
- Varying numbers of slides
- Different
slidesToShowandslidesToScrollvalues - Responsive breakpoints
Follow code style
- Match existing code style and formatting
- Use meaningful variable and function names
- Add comments for complex logic
- Keep changes focused and minimal
Pull Request Requirements
Code Requirements
Code Requirements
Your pull request must:
- Include a clear description of what it changes
- Reference related issues (e.g., “Fixes #123”)
- Include a jsFiddle demonstrating the fix/feature
- Work with all Slick modes and configurations
- Not break existing functionality
- Follow existing code style
- Include comments for complex changes
Testing Requirements
Testing Requirements
You must test your changes with:
Documentation Requirements
Documentation Requirements
If your PR adds new features:
- Update README.markdown with new options
- Document new methods or events
- Provide usage examples
- Update relevant documentation pages
Pull Request Process
Commit your changes
Fix: Corrects edge case with infinite scrollFeature: Add new pauseOnDotsHover optionDocs: Update browser support information
Push and create PR
- Clear title and description
- Link to your jsFiddle demo
- Reference to related issues
- Browser testing results
Development Setup
Building from Source
Project Structure
Coding Standards
JavaScript Style
JavaScript Style
- Use semicolons
- 4-space indentation
- Single quotes for strings
- Meaningful variable names
- Comment complex logic
CSS Style
CSS Style
- Use existing class naming conventions
- Prefix all Slick classes with
.slick- - Keep specificity low
- Comment unusual CSS
Code of Conduct
Our Standards
- Be respectful and professional
- Welcome newcomers and help them learn
- Accept constructive criticism gracefully
- Focus on what’s best for the project
- Show empathy towards other community members
Unacceptable Behavior
- Harassment or discriminatory comments
- Trolling or insulting remarks
- Personal or political attacks
- Publishing others’ private information
- Any conduct inappropriate in a professional setting
Ownership and Rights
You will be listed in GitHub as a contributor, but the project maintainer retains final decision-making authority on the project’s direction.
While Slick is open source, this is still my baby, and by submitting a pull request you are authorizing me to edit or modify it in any way shape or form. You will be listed in GitHub as a contributor, but I have and will continue to steer the direction of this project.
Recognition
Contributors are recognized through:- GitHub’s contributor list
- Mention in release notes (for significant contributions)
- Community acknowledgment
License
Slick Carousel is licensed under the MIT License.Questions?
If you have questions about contributing:Gitter Chat
Ask the community
Stack Overflow
Search or ask questions
Additional Resources
Troubleshooting
Common issues and solutions
Browser Support
Compatibility information
Migration Guide
Upgrading between versions
GitHub Repository
View source code
Thank you for contributing to Slick Carousel! Your efforts help make it better for everyone.