Contribution Guide

Welcome Contributors

We're thrilled you're interested in contributing to the Sunbird AI Assistant Building Block! As an open-source project in a fast-paced field, we welcome all contributions, from new features and improved infrastructure to better documentation and bug fixes.

Getting Started

New to the Project?

No worries! Get acquainted with our project by exploring the documentation.

Ways to Contribute

There are many ways to get involved and make a difference. Here are some common areas where people contribute:

• Improve the Documentation: Help us make the docs, including this one, even better! Your edits, suggestions, and additions are invaluable.

• Code, Fix Bugs, and Improve Infrastructure: We welcome your coding expertise! Help us write new features, fix bugs, or improve our infrastructure.

• Integrate with Favourite Vendors or Tools: Do you have a favourite tool or vendor you'd love to see integrated with Sunbird? Please share your knowledge and help us make it happen!

• Answer Usage Questions and Discuss Issues: Help us build a strong community by answering user questions, discussing issues, and providing valuable insights.

It's essential to discuss significant contributions to our discussion forum before proceeding to ensure your work aligns with the project's goals and direction.

Discussions Forums

We have a Discussions page where users can ask usage questions, discuss design decisions, and propose new features.

If you can help answer questions, please do so! This will allow the maintainers to focus more on development and bug fixing.

Core Contributions

We primarily accept contributions through pull requests. Here's what you need to know:

• Fork the Repository: Create a fork of our repository on GitHub.

• Clone your Fork: Clone your forked repository to your local machine.

• Make Changes: Make your changes and write clear commit messages.

• Test your Changes: Ensure your changes function properly and adhere to our coding standards.

• Push to your Fork: Push your changes to your forked repository.

• Open a Pull Request: Submit a pull request to our main repository.

Important: By issuing a Pull Request, you agree to allow the project owners to license your work under the terms of the License.

Pull Request Checkpoints:

• Testing: All pull requests should include thorough testing to guarantee functionality and avoid breaking existing features.

• Code Style: Adhere to coding style guidelines to promote readability and maintainability for everyone.

• Clear Description: Provide a clear and concise description of your changes in the pull request. This will help reviewers understand your contribution.