Ninja-Image-Compare-Slider
Thank you for considering contributing to Image Compare Slider.
This project aims to remain:
- Lightweight
- Dependency-free
- Accessible
- Easy to understand
- Production-ready
Before submitting a contribution, please read this document carefully.
Project Philosophy
This component intentionally avoids:
- Framework dependencies
- Build steps
- Heavy abstractions
- Over-engineering
Every line of code must justify its existence.
If a feature adds complexity without significant value, it will likely be rejected.
Clarity > cleverness.
Performance > novelty.
Maintainability > trends.
Reporting Bugs
When opening an issue, include:
- Browser and version
- Operating system
- Clear reproduction steps
- Expected behavior
- Actual behavior
- Screenshots or video (if helpful)
Minimal reproducible examples are strongly encouraged.
Proposing Features
Before proposing a new feature, ask:
- Does this align with the core purpose?
- Can it be implemented without increasing bundle size significantly?
- Can it be achieved with CSS instead of JavaScript?
- Is it broadly useful?
Feature requests that introduce dependencies will not be accepted.
Development Guidelines
- No external libraries
- No bundlers required
- No transpilers
- Modern JavaScript only
- Keep the file size small
- Maintain accessibility
Code Style
- Clear variable names
- No unnecessary abstractions
- Avoid global state
- Keep logic instance-scoped
- Comment only where intent is not obvious
Testing Contributions
Before submitting a pull request:
- Test with multiple sliders on the same page
- Test keyboard interaction
- Test touch interaction
- Test in Chrome, Firefox, and Safari
Pull Request Process
- Fork the repository
- Create a feature branch
- Make your changes
- Keep commits clean and meaningful
- Submit a pull request with a clear description
Small focused pull requests are preferred over large ones.
What Will Be Rejected
- Framework integrations
- Large refactors without clear benefit
- Feature bloat
- Code that reduces readability
- Breaking changes without strong justification
Code of Conduct
All contributors are expected to follow the Code of Conduct.
Be respectful.
Be constructive.
Be professional.
Support the Project
If this project helps you or your company, consider supporting its development.
You can buy me a coffee here:
👉 
Support is optional but appreciated.
Maintained By
Hanami Software
https://github.com/HanamiSoftware
Building small, focused, and reliable software.