Thank you for your interest in contributing to LocalAI! We appreciate your time and effort in helping to improve our project. Before you get started, please take a moment to review these guidelines.
- Golang [1.21]
- Git
- macOS/Linux
- Clone the repository:
git clone https://github.com/go-skynet/LocalAI.git - Navigate to the project directory:
cd LocalAI - Install the required dependencies:
make prepare - Run LocalAI:
make run
We welcome contributions from everyone! To get started, follow these steps:
If you find a bug, have a feature request, or encounter any issues, please check the issue tracker to see if a similar issue has already been reported. If not, feel free to create a new issue and provide as much detail as possible.
- Fork the repository.
- Create a new branch with a descriptive name:
git checkout -b [branch name] - Make your changes and commit them.
- Push the changes to your fork:
git push origin [branch name] - Create a new pull request from your branch to the main project's
mainormasterbranch. - Provide a clear description of your changes in the pull request.
- Make any requested changes during the review process.
- Once your PR is approved, it will be merged into the main project.
- No specific coding guidelines at the moment. Please make sure the code can be tested. The most popular lint tools like []
golangci-lint](https://golangci-lint.run) can help you here.
make test cannot handle all the model now. Please be sure to add a test case for the new features or the part was changed.
- We are welcome the contribution of the documents, please open new PR in the official document repo localai-website
- You can reach out via the Github issue tracker.
- Open a new discussion at Discussion
- Join the Discord channel Discord