CONTRIBUTING.md

Contribute

• Getting Started
  • Requirements
  • First setup
  • Optional requirements
• Local Development
  • Test
• Documentation
  • Readme
• 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.

Local Development

Test

make test

or

make test-watch

Documentation

Readme

Important

Do not edit the README.md file directly. It is generated from the README.template.md file.

1. Edit the README.template.md file.
2. Run make readme to generate/update the README.md file.

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.