mistralai-client-rs/CONTRIBUTING.md

Contribute

• Getting Started
  • Requirements
  • First setup
  • Optional requirements
  • Test
• Code of Conduct
• Commit Message Format

---

Getting Started

Requirements

• Rust: v1

First setup

Important

If you're under Windows, you nust run all CLI commands under a Linux shell-like terminal (i.e.: WSL or Git Bash).

Then run:

git clone https://github.com/ivangabriele/mistralai-client-rs.git # or your fork
cd ./mistralai-client-rs
cargo build
cp .env.example .env

Then edit the .env file to set your MISTRAL_API_KEY.

Note

All tests use either the open-mistral-7b or mistral-embed models and only consume a few dozen tokens. So you would have to run them thousands of times to even reach a single dollar of usage.

Optional requirements

• cargo-llvm-cov for make test-cover
• cargo-watch for make test-watch.

Test

make test

or

make test-watch

Code of Conduct

Help us keep this project open and inclusive. Please read and follow our Code of Conduct.

Commit Message Format

This repository follow the Conventional Commits specification.