Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 1.88 KB
Raw

Contributing to LLM-Assistant

Thank you for considering contributing to the LLM-Assistant project! We appreciate your interest and support. This guide will provide you with the necessary information to get started.

Table of Contents

Introduction

LLM-Assistant is a VAIT incubation project that aims to provide a Large Language Model (LLM) assistant for our Discord channel. The project is open-source and welcomes contributions from the community. If you are interested in contributing to LLM-Assistant, please read the following guidelines to get started.

Getting Started

To get started with contributing to LLM-Assistant, please follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your changes.
  4. Make your desired changes to the codebase.
  5. Test your changes thoroughly.
  6. Commit your changes with a descriptive commit message.
  7. Push your changes to your forked repository.
  8. Submit a pull request to the main repository.

Development Environment

LLM-Assistant uses a devcontainer to provide a consistent development environment. To set up the devcontainer, follow these steps:

  1. Install Docker on your machine if you haven't already.
  2. Install the Remote - Containers extension in Visual Studio Code.
  3. Open the project folder in Visual Studio Code.
  4. Click on the green/blue icon in the bottom-left corner of the window and select "Reopen in Container".
  5. Visual Studio Code will automatically build the devcontainer and open a new window with the development environment.