Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 1.53 KB

File metadata and controls

43 lines (30 loc) · 1.53 KB

Contributing to GenAI Workshops

Thank you for your interest in improving these workshops! 🎉

How to Contribute

Reporting Issues

  • Bug in code? Open an issue with the workshop number, the cell/module, and the error message.
  • Broken link? Open an issue with the file path and the link that's broken.
  • Suggestion? Open an issue describing your idea.

Pull Requests

  1. Fork the repository
  2. Create a branch: git checkout -b fix/workshop-2-image-bug
  3. Make your changes — keep them focused on one issue
  4. Test your changes:
    • For notebooks: run all cells in a clean Colab environment
    • For Python scripts: run in demo mode (WORKSHOP_BACKEND=demo)
  5. Submit a PR with a clear description of what you changed and why

Guidelines

  • Keep it beginner-friendly: These are educational materials. Clarity > cleverness.
  • Test everything: Every code cell/script should run without errors.
  • No secrets: Never commit API keys, tokens, or personal paths.
  • Consistent style: Follow the existing formatting patterns in each workshop.

What We're Looking For

  • 🐛 Bug fixes in code cells or scripts
  • 📝 Improved explanations or documentation
  • 🔗 Updated links to external resources
  • 🌐 Translations (create a translations/ folder in the relevant workshop)
  • ✨ New interactive exercises or challenges

Code of Conduct

Be respectful, inclusive, and constructive. We're all here to learn.

Questions?

Open an issue titled "Question: [your topic]" and we'll get back to you.