Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (26 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

37 lines (26 loc) · 1.1 KB
Raw

Contributing to scraperapi-alternative

First off, thanks for taking the time to contribute!

Getting Started

  1. Fork this repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/scraperapi-alternative.git
  3. Create a virtual environment: python -m venv venv && source venv/bin/activate
  4. Install dependencies: pip install -r requirements.txt
  5. Create a branch: git checkout -b feature/your-feature-name

Development

  • Follow PEP 8 style guidelines
  • Add docstrings to all functions and classes
  • Write unit tests for new features
  • Keep the scraper modular and well-documented

Submitting Changes

  1. Run any existing tests: python -m pytest
  2. Commit your changes: git commit -m "Add: your feature description"
  3. Push to your fork: git push origin feature/your-feature-name
  4. Create a Pull Request with a clear description

Reporting Bugs

Please use the GitHub Issues tab to report bugs. Include:

  • Python version
  • Operating system
  • Error traceback
  • Steps to reproduce

License

By contributing, you agree that your contributions will be licensed under the MIT License.