Thank you for considering contributing to this project! Your contributions are vital in making this tool more effective and accessible. This document outlines the guidelines for contributing to the project.
Before you begin contributing, make sure to follow the steps below to set up the project locally and familiarize yourself with the codebase.
- Python 3.8+
- Pip or Conda for package management
- GPU (optional, but recommended for faster feature extraction)
-
Clone the repository:
git clone https://github.com/ahmadjaved97/ImageClusterViz.git cd ImageClusterViz -
Set up a virtual environment:
python -m venv venv source venv/bin/activate -
Install the required dependencies:
pip install -r requirements.txt
We encourage you to contribute to the project by reporting bugs, suggesting new features, improving documentation, or submitting code contributions.
If you encounter any bugs or have suggestions for improvements, please create an issue on the GitHub issue tracker. Please provide a clear and concise description of the issue, including steps to reproduce it if it's a bug.
Feature requests are also welcome! Please open an issue for feature suggestions and provide details on how the feature would enhance the project. When possible, describe the use case to help us understand your needs.
- Be respectful and constructive in your communication.
- Provide clear and concise commit messages and issue descriptions.
- Ensure that any feedback provided to other contributors is thoughtful and - actionable.
By contributing to this project, you agree that your contributions will be licensed under the MIT License.