Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

27 lines (20 loc) · 1.5 KB
Raw

Contributing to llm-chain

First of all, thank you for considering contributing to our project! 🎉 We are delighted to have you here and truly appreciate your interest in making our project even better. Your contributions and ideas are highly valued.

Getting Started

Prerequisites

Install cmake

  • MacOS: brew install cmake
  • Ubuntu: sudo apt-get install cmake

Install protobuf

  • MacOS: brew install protobuf
  • Ubuntu: sudo apt-get install protobuf-compiler
  1. Make your own fork of llm-chain.
  2. git clone --recurse-submodule git@github.com:<YOUR GITHUB ACCOUNT HERE>/llm-chain.git your fork to your local machine.
  3. Follow the instructions on the rustup website to install Rust.
  4. Test that everything went well with cargo test
  5. Make your changes in a new branch, following the coding guidelines and best practices.
  6. Commit and push your changes to your fork.
  7. Open a pull request against the main repository. 🚀

Before You Contribute

We are open to new ideas and contributions that align with the project's goals and vision. However, if you're planning on working on something significantly different from what's already in the project, we strongly recommend getting in touch with us before you start.

You can reach out to us by opening an issue, starting a discussion, or sending an email. This way, we can discuss your ideas, provide guidance, and ensure that your efforts are more likely to be merged into the project.