Documentation

Contribuer

Comment préparer des changements, lancer les checks et garder docs et tests alignés.

Attentes

  • utilisez Rust 1.90 ou plus récent
  • gardez le code et les messages utilisateur en anglais
  • gardez des changements focalisés
  • mettez à jour tests et docs quand le comportement change

Checks standards

cargo fmt --all --check
cargo clippy --workspace --all-targets --all-features -- -D warnings
cargo test --workspace

Attentes documentaires

Quand le comportement change:

  • mettez à jour README.md si l’onboarding ou le positionnement change
  • mettez à jour website/ si la doc publique change
  • mettez à jour les fichiers TOML d’exemple si le modèle de configuration change
  • mettez à jour la rustdoc quand les APIs Rust publiques changent

Pull requests

Incluez:

  • un court résumé
  • les étapes de validation
  • les mises à jour de tests pertinentes
  • les mises à jour documentaires pertinentes