Skip to content

Contributing

We are excited to have the community come together to enhance and expand RagBuilder and making it the gold-standard of information-retrieval orchestration & evaluation for LLM apps. Your contributions are invaluable and help make RagBuilder a better resource for developers everywhere.

How Can You Contribute?

We welcome contributions of all kinds and from developers of all levels. Here are several ways you can contribute to RagBuilder:

Code Contributions

  1. Feature Requests: Suggest and implement new features that can enhance RagBuilder's capabilities.
  2. Bug Fixes: Identify and resolve bugs to improve the stability and performance of the tool.
  3. Performance Improvements: Optimize the codebase for better speed and efficiency.
  4. Documentation: Improve existing documentation or create new documentation to help users better understand and utilize RagBuilder.

Testing

  1. Unit Tests: Write unit tests to ensure the robustness of individual components.
  2. Integration Tests: Develop integration tests to verify the cooperation between different parts of the system.
  3. User Testing: Engage in user testing to identify usability issues and areas for improvement.

Support & Community

  1. Issue Resolution: Engage with the community to troubleshoot and resolve issues reported on the GitHub issues page.
  2. Discussion: Participate in discussions to help shape the future development of RagBuilder.
  3. Workshops & Tutorials: Create educational content such as workshops, tutorials, and webinars to help new users get started with RagBuilder.

Getting Started

  1. Fork the Repository: Start by forking the RagBuilder repository on GitHub.
  2. Clone the Repository: Clone your fork to your local machine for development.
  3. Create a Branch: Create a new branch for your feature or bug fix.
  4. Make Changes: Implement your changes, ensuring to follow the style guidelines and best practices.
  5. Run Tests: Make sure all tests pass before submitting your contribution.
  6. Submit a Pull Request: Push your branch to GitHub and open a pull request against the main repository. Provide a clear and concise description of the changes you have made.

Code of Conduct

By contributing to RagBuilder, you agree to abide by our Code of Conduct, which helps us ensure a welcoming and inclusive environment for everyone.

Feel free to reach out to us via GitHub Issues or Discussions if you have any questions or need further assistance. Happy coding!