Contributing
Welcome! We’re excited that you’re interested in contributing to Agent Data Shuttle.
Whether you’re fixing a bug, adding a feature, improving documentation, or just asking questions, your involvement helps make this protocol better for everyone.
Getting Started
New to the project? Here’s how to jump in:
- Explore our repositories - Check out our GitHub organization  to see all our projects including the protocol specification, SDKs, and documentation
- Read the documentation - Get started with our introduction
- Join the conversation - Connect with other contributors on the discussions section of each repository.
Our Repositories
We maintain several repositories that work together:
- ADS Bridge - The codebase of the ADS Bridge, which handles event distribution
- Documentation - This website and all user-facing docs
- SDKs - Client libraries for different programming languages
- Examples - Sample implementations and use cases
Each repository has its own contributing guidelines, so check the specific repo’s README for detailed instructions.
Ways to Contribute
Show You’re a Contributor
We appreciate your contributions and would love for you to share it with the world!
Add our contributor badge to your GitHub README!
Copy and paste this markdown snippet into your README:
Thank you for helping us grow the community!
Code Contributions
Found a bug or have an idea for a new feature? We’d love your help!
Before you start coding:
- Check the relevant repository’s open issues to see if someone’s already working on it
- For major changes, open a discussion first to chat about your approach in the relevant repository
- Make sure you’re contributing to the right repository
Development workflow:
- Fork the relevant repository and create a feature branch
- Make your changes
- Test your changes locally
- Submit a pull request with a clear description of what you’ve changed
Documentation
Great documentation makes all the difference! You can help by:
- Fixing typos or unclear explanations in our docs repository 
- Adding examples to existing docs
- Writing tutorials for common use cases
- Improving SDK documentation
SDK Development
Help us build better developer tools by:
- Adding support for new programming languages
- Fixing bugs in existing SDKs
- Improving SDK documentation and examples
- Adding new features to existing SDKs
Testing and Bug Reports
Help us keep the protocol stable by testing new releases and reporting issues.
When reporting bugs, please:
- Report the issue in the relevant repository
- Include steps to reproduce the issue
- Mention expected vs actual behavior
- Share your environment details (OS, language version, etc.)
- Include any relevant error messages or logs
Development Setup
The setup process varies by repository. Check each repository’s README for specific setup instructions.
Community Guidelines
We’re building an inclusive community where everyone feels welcome. Please:
- Be respectful and constructive in all interactions
- Help newcomers get started
- Focus on what’s best for the community
Need Help?
Stuck on something? Don’t hesitate to reach out:
- Questions about the code: Open a GitHub discussion or an issue in the relevant repository
- Other queries: Email us at [email protected]
Thanks for being part of our community. Together, we’re building something amazing! 🚀