Contributing
Thank you for your interest in contributing to GPlay Scraper!
Development Setup
Fork the repository on GitHub
Clone your fork locally:
git clone https://github.com/yourusername/gplay-scraper.git cd gplay-scraper
Install in development mode:
pip install -e .
Install development dependencies:
pip install pytest sphinx sphinx-rtd-theme
Running Tests
Run the test suite:
python -m pytest tests/ -v
Run tests with coverage:
python -m pytest tests/ -v --cov=gplay_scraper
Code Style
Follow PEP 8 style guidelines
Add docstrings to new functions and classes
Include type hints where appropriate
Write descriptive commit messages
Documentation
Build documentation locally:
python build_docs.py
The documentation will be available at docs/_build/html/index.html
.
Submitting Changes
Create a feature branch:
git checkout -b feature-name
Make your changes
Add tests for new functionality
Run tests to ensure they pass
Update documentation if needed
Commit your changes:
git commit -m "Add feature: description"
Push to your fork:
git push origin feature-name
Submit a pull request on GitHub
Reporting Issues
Please use GitHub Issues to report bugs or request features. Include:
Python version
Operating system
Steps to reproduce the issue
Expected vs actual behavior
Error messages (if any)
Code of Conduct
Be respectful and inclusive
Focus on constructive feedback
Help others learn and grow
Follow the project’s coding standards
Thank you for contributing! 🚀