Skip to content

Contributing

Thank you for your interest in contributing to Open Chat Studio! This guide will help you understand the contribution process and code style conventions.

Getting Started

Before contributing, please make sure you've set up your development environment according to the Getting Started guide.

Forms of Contribution

Provide Feedback

  • Report Bugs / Issues
    If you encounter any issues or unexpected behavior in Open Chat Studio or its components, you can create a new issue in the GitHub issue tracker.

  • Propose New Features / Improvements
    If you have a suggestion for improving Open Chat Studio or want to share your ideas, you can open a new GitHub Discussion. If your idea is well-defined, you can also create a Feature Request Issue.
    Provide a detailed description, including use cases, benefits, and potential challenges. Even if your idea is not immediately prioritized, it may still be considered later or taken up by the community.

Contribute Code Changes

Before starting, ensure that the change has not already been implemented. You can build Open Chat Studio using the latest main branch and confirm that the modification is still needed. If the feature is complex, discuss it first in the GitHub Discussions.

Improve Documentation

  • Developer Documentation needs improvement, and we welcome contributions.
  • User Documentation is maintained in the open-chat-studio-docs repository and published at docs.openchatstudio.com.
  • The easiest way to contribute to documentation is by reviewing and providing feedback. If you notice errors or opportunities for improvement, reach out to documentation contributors or create a Pull Request directly.

Technical Guide

This section provides the necessary steps to set up your environment, build Open Chat Studio locally, and run tests.

1. Set Up Your Environment

Before contributing, please make sure you've set up your development environment according to the Getting Started guide.

2. Start Working on Your First Issue

To contribute, pick a task from the Good First Issues board. To be assigned to an issue, leave a comment with the .take command in the selected issue.

3. Submit a Pull Request (PR)

Follow our Pull Request guidelines.

Getting Help

If you have any questions or need assistance: - Use GitHub Discussions for general queries. - Check existing issues or open a new one if necessary. - Reach out to maintainers in GitHub if you need further guidance.

License

By contributing to Open Chat Studio, you agree that your contributions will be licensed under the terms stated in the LICENSE file.