Open-Source Code

Open Source Code

This guide is designed to provide you with all the information you need to make valuable contributions to our project.

Getting Started with Contribution

1. Understanding the Project Structure

Before you start contributing, take some time to familiarize yourself with the Allora-network's structure. Our project consists of various components and modules, each with its documentation and specific focus. You can explore the project's GitHub repository to understand how it's organized and where to find the parts you're interested in.

2. Setting Up Your Development Environment

To contribute, you'll need to set up your development environment:

  • Fork and Clone the Repository: Start by forking the Allora-network repository on GitHub and cloning your fork to your local machine.
  • Install Dependencies: Follow the setup instructions in the README file to install the necessary dependencies for your chosen component.

3. Adhering to Coding Standards

Consistency is key in a collaborative project. Please adhere to the coding standards outlined in our documentation, including naming conventions, commenting styles, and code formatting. This ensures that our codebase remains clean, readable, and easy to maintain.

4. Submitting Contributions

When you're ready to submit your contributions, follow these steps:

  • Make sure your code adheres to the project's coding standards and includes relevant tests.
  • Create a pull request (PR) against the main branch of the Allora-network repository.
  • Provide a clear description of the changes in your PR and reference any related issues.
  • Your submission will undergo a review process by the project maintainers. Be open to feedback and be ready to make additional changes if necessary.

Developer Certificate of Origin (DCO)

What is DCO?

The Developer Certificate of Origin is a declaration that you have the right to contribute the code or documentation you're submitting. By signing off your contributions (with a git commit -s), you affirm that you adhere to the DCO's terms.

Apache Licensing

The Allora-network uses the Apache License, which protects both the project and its contributors. When you contribute, ensure that your submissions are compatible with this license. This means:

Your contributions are under the same license, or a compatible one.
You have the right to contribute the code or documentation.

Need Help?

If you have questions or need assistance, don't hesitate to reach out. The Allora-network community is here to help and support each other. Check our documentation for FAQs, and use the community channels to ask for help.

Top Allora Repositories

You can find the complete list of Allora Open Source repositories in the Allora Network github org: https://github.com/allora-network (opens in a new tab)