Skip to content

Latest commit

Β 

History

History
44 lines (34 loc) Β· 1.17 KB

CONTRIBUTING.md

File metadata and controls

44 lines (34 loc) Β· 1.17 KB

Contributing to ScrapeGraphAI πŸš€

Hey there! Thanks for checking out ScrapeGraphAI! We're excited to have you here! πŸŽ‰

Quick Start Guide πŸƒβ€β™‚οΈ

  1. Fork the repository from the pre/beta branch 🍴
  2. Clone your fork locally πŸ’»
  3. Install uv (if you haven't):
    curl -LsSf https://astral.sh/uv/install.sh | sh
  4. Run uv sync (creates virtual env & installs dependencies) ⚑
  5. Run uv run pre-commit install πŸ”§
  6. Make your awesome changes ✨
  7. Test thoroughly πŸ§ͺ
  8. Push & open a PR to the pre/beta branch 🎯

Contribution Guidelines πŸ“

Keep it clean and simple:

  • Follow our code style (PEP 8 & Google Python Style) 🎨
  • Document your changes clearly πŸ“š
  • Use these commit prefixes for your final PR commit:
    feat: ✨ New feature
    fix: πŸ› Bug fix
    docs: πŸ“š Documentation
    style: πŸ’… Code style
    refactor: ♻️ Code changes
    test: πŸ§ͺ Testing
    perf: ⚑ Performance
    
  • Be nice to others! πŸ’

Need Help? πŸ€”

Found a bug or have a cool idea? Open an issue and let's chat! πŸ’¬

License πŸ“œ

MIT Licensed. See LICENSE file for details.

Let's build something amazing together! 🌟