Skip to content

Contributing to ImgCompress

Thank you for your interest in contributing to ImgCompress! As an open-source project, I welcome contributions of all forms, from bug reports and feature suggestions to code improvements and documentation updates.

🤝 Ways to Contribute

There are many ways you can help make this project better:

1. ⭐ Support the Project

Simply starring the repository on GitHub helps increase visibility and lets me know you appreciate the tool.

2. 🐛 Report Bugs & Request Features

Found a bug or have an idea for a new feature? * Check the Issue Tracker to see if it has already been reported. * If not, open a new issue with a clear description and reproduction steps.

3. 💻 Code Contributions

Developers are welcome to fork the repository and submit Pull Requests (PRs).

  • 🐛 Fix Bugs: Look for issues labeled bug.
  • ✨ New Features: Look for issues labeled enhancement or help wanted.
  • 👶 Good First Issues: If you are new to the project, check out good first issue tasks.

🛠️ Developer Resources

If you are planning to write code, please refer to the comprehensive Developer Guide.

It covers everything you need to know about:

  • 💻 Local Environment: Setting up your local development environment.
  • 🧪 Testing: Running Unit, Integration, and E2E tests.
  • 🚀 Dev Container: Using the VS Code Dev Container for a zero-config setup.

📝 License

By contributing, you agree that your contributions will be licensed under the project's GNU General Public License v3.0 (GPL-3.0).