Contributing Guide
Contribute to the imgcompress open-source project: submit bug reports, feature requests, and pull requests. Learn how the project is structured and how to get your changes merged and shipped.
Contributing to ImgCompress
Thank you for your interest in contributing to ImgCompress! I welcome contributions of all kinds, from bug reports and feature ideas to code improvements and documentation fixes.
Ways to Contribute#
1. Star the repo#
Starring on GitHub helps more people find the project and lets me know you find it useful.
2. Report bugs and request features#
Check the Issue Tracker first to see if it has already been reported. If not, open a new issue with a clear description and steps to reproduce.
3. Submit code#
Fork the repository and open a Pull Request.
- Fix bugs: look for issues labeled
bug - New features: look for issues labeled
enhancementorhelp wanted - Good first issue: a good starting point if you're new to the project
Developer Resources#
I only accept changes that pass the full test suite (unit, integration, and E2E). If a test fails because of a feature change, please add or update E2E tests so behavior stays stable. Start with the Developer Guide and the Playwright E2E Testing Guide.
The Developer Guide covers:
- Local environment: setting up your dev environment
- Testing: running unit, integration, and E2E tests
- Dev Container: a zero-config VS Code setup with everything pre-installed
License#
By contributing, you agree your changes will be licensed under the project's GNU General Public License v3.0 (GPL-3.0).