Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (47 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

66 lines (47 loc) · 2.59 KB
Raw

Contributing to GAIA

🚀 Welcome to the GAIA Community! 🚀

We're excited that you're interested in making GAIA better! Whether you're reporting an issue, suggesting improvements, or contributing code, your help is valuable to us. Let's work together to make GAIA even more amazing!

🐛 Sharing Issues and Ideas

Found a bug or have a suggestion? We'd love to hear from you! Here's how you can help:

  1. Take a quick look at our Issues tab to see if someone else has reported something similar
  2. If you don't find anything similar, feel free to open a new issue
  3. We have friendly templates to help guide you through sharing the information that will help us understand and address your report

When reporting issues, try to include:

  • What you were trying to do
  • What happened instead
  • Any error messages or screenshots that might help
  • Your setup (OS, hardware, GAIA version)

The more details you can share, the better we can help - but don't worry if you can't provide everything!

💡 Contributing Code

Want to help improve GAIA directly? That's fantastic! Here's how you can get started:

  1. Pick an Issue: Find something you'd like to work on or fix
  2. Let Us Know: Comment on the issue to let others know you're working on it
  3. Make Your Changes:
    • Follow the project's coding style
    • Add tests for new features if possible
    • Update documentation as needed
    • Keep your changes focused and specific
  4. Submit a Pull Request:
    • Describe what you're trying to solve
    • Explain how your changes address the issue
    • Keep an eye on any feedback or questions

📝 Documentation

Clear documentation helps everyone! You can help by:

  • Fixing typos or unclear instructions
  • Adding examples or use cases
  • Creating guides or tutorials
  • Improving existing documentation

⏱️ Timeline Expectations

We try to review and respond to contributions as quickly as we can. To help keep things moving:

  • We aim to acknowledge new issues and PRs within a few days
  • For pull requests, try to be responsive to any feedback
  • If you need to step away from a PR you're working on, just let us know

🤝 Working Together

Remember:

  • Every contribution, no matter how small, is valuable
  • Be kind and respectful in your interactions
  • Ask questions if you're unsure about anything
  • Help others when you can

🌟 Thank You!

Your interest in improving GAIA means a lot to us. Whether you're reporting bugs, suggesting features, or contributing code, you're helping make GAIA better for everyone.

Let's build something amazing together! ✨