mirror of https://github.com/mudler/LocalAI.git synced 2024-12-18 20:27:57 +00:00

**Description**

This PR is related to  #105 

**Notes for Reviewers**


**[Signed
commits](../CONTRIBUTING.md#signing-off-on-commits-developer-certificate-of-origin)**
- [x] Yes, I signed my commits.
 
<!--
Thank you for contributing to LocalAI! 

Contributing Conventions
-------------------------

The draft above helps to give a quick overview of your PR.

Remember to remove this comment and to at least:

1. Include descriptive PR titles with [<component-name>] prepended. We
use [conventional
commits](https://www.conventionalcommits.org/en/v1.0.0/).
2. Build and test your changes before submitting a PR (`make build`). 
3. Sign your commits
4. **Tag maintainer:** for a quicker response, tag the relevant
maintainer (see below).
5. **X/Twitter handle:** we announce bigger features on X/Twitter. If
your PR gets announced, and you'd like a mention, we'll gladly shout you
out!

By following the community's contribution conventions upfront, the
review process will
be accelerated and your PR merged more quickly.

If no one reviews your PR within a few days, please @-mention @mudler.
-->

---------

Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: Aisuko <urakiny@gmail.com>
Co-authored-by: Ettore Di Giacinto <mudler@users.noreply.github.com>

2023-09-24 14:54:55 +02:00

2.8 KiB

Raw Blame History

Contributing to localAI

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.

Getting Started
- Prerequisites
- Setting up the Development Environment
Contributing
- Submitting an Issue
- Creating a Pull Request (PR)
Coding Guidelines
Testing
Documentation
Community and Communication

Getting Started

Prerequisites

Golang [1.21]
Git
macOS/Linux

Setting up the Development Environment and running localAI in the local environment

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

Contributing

We welcome contributions from everyone! To get started, follow these steps:

Submitting an Issue

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.

Creating a Pull Request (PR)

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 main or master branch.
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.

Coding Guidelines

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.

Testing

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.

Documentation

We are welcome the contribution of the documents, please open new PR in the official document repo localai-website

Community and Communication

You can reach out via the Github issue tracker.
Open a new discussion at Discussion
Join the Discord channel Discord

2.8 KiB Raw Blame History