Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Compile Failed for llm-chain-llama-sys & llm-chain-llama #248 #274

Merged
merged 1 commit into from
Mar 7, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,22 @@
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`](https://github.com/sobelio/llm-chain).
2. `git clone` your fork to your local machine.
2. ` git clone --recurse-submodule [email protected]:<YOUR GITHUB ACCOUNT HERE>/llm-chain.git` your fork to your local machine.
3. Follow the instructions on the [rustup website](https://rustup.rs/) to install Rust.
4. Fetch the project's submodules with `git submodule update`
5. Test that everything went well with `cargo test`
6. Make your changes in a new branch, following the coding guidelines and best practices.
7. Commit and push your changes to your fork.
8. Open a pull request against the main repository. 🚀
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

Expand Down