Skip to content

Latest commit

 

History

History
98 lines (67 loc) · 5.51 KB

CONTRIBUTING.md

File metadata and controls

98 lines (67 loc) · 5.51 KB
Raw

Contributing to LLM Assistant Deployment Scripts

First off, thanks for taking the time to contribute! ❤️

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.

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the LLM Assistant Deployment Scripts Code of Conduct. By participating, you are expected to uphold this code.

I Want To Contribute

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version.
  • Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
  • Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
  • Collect information about the bug:
  • Stack trace (Traceback)
  • OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
  • Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
  • Possibly your input and the output
  • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

How Do I Submit a Good Bug Report?

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.

Once it's filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as needs-repro. Bugs with the needs-repro tag will not be addressed until they are reproduced.
  • If the team is able to reproduce the issue, it will be marked needs-fix, as well as possibly other tags (such as critical), and the issue will be left to be implemented by someone.

Your First Code Contribution

To get started with contributing to Deploy LLM Bot project, 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

In a virtualenv, simple run:

  1. pip install -r dev-requirements.txt
  2. pre-commit install

Styleguides

This project follow the Conventional Commits v1.0 specification. For more information, please refer to:

https://www.conventionalcommits.org/en/v1.0.0/

Join The Project Team

To join the project team, please message us on Discord at https://chat.vietausit.com

Attribution

This guide is based on the contributing-gen. Make your own!