Scrapegraph-ai/CONTRIBUTING.md

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! 🌟