Skip to content

O-clock-Rust/rust-code-quality-journey

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Générateur de mots de passe en Rust - Projet éducatif

Introduction

Bienvenue dans ce projet éducatif de générateur de mots de passe en Rust ! Ce projet a pour but de démontrer les étapes de création d'un code propre, bien structuré et testé, en utilisant Rust comme langage de programmation.

Le projet consiste en une bibliothèque de génération de mots de passe et une interface en ligne de commande (CLI) pour l'utiliser. À travers ce projet, nous explorerons les meilleures pratiques de développement, de la conception initiale aux tests approfondis.

Structure du projet

Ce projet est organisé en plusieurs branches Git, chacune représentant une étape spécifique du processus de développement :

  • main (Étape 0) : Conception du projet
  • etape1-code-fonctionnel : Implémentation de base
  • etape2-gestion-logs : Ajout de la gestion des logs
  • etape3-gestion-erreurs : Implémentation de la gestion des erreurs avec anyhow
  • etape4-documentation : Ajout de la documentation complète
  • etape5-tests : Implémentation des tests unitaires et d'intégration

Chaque branche construit sur la précédente, ajoutant de nouvelles fonctionnalités ou améliorations.

Étape 0 : Conception du projet

Vous êtes actuellement sur la branche main, qui représente l'étape 0 de notre projet : la phase de conception.

Objectifs de cette étape

  1. Définir la structure globale du projet
  2. Identifier les principales fonctionnalités
  3. Planifier l'architecture de la bibliothèque et de la CLI
  4. Établir les lignes directrices pour le développement

Documents clés

  • CONCEPTION.md : Ce document détaille l'architecture, les fonctionnalités, et les considérations techniques du projet.

Prochaines étapes

Pour commencer le développement et voir l'implémentation de base, passez à la branche etape1-code-fonctionnel :

git checkout etape1-code-fonctionnel

Comment utiliser ce projet

  1. Explorez chaque branche dans l'ordre pour voir l'évolution du projet.
  2. Lisez les README spécifiques à chaque étape pour comprendre les changements et les nouveaux concepts introduits.
  3. Examinez le code et les tests pour voir comment les meilleures pratiques sont appliquées.

Contribution

Ce projet est principalement éducatif, mais les suggestions d'amélioration sont les bienvenues. N'hésitez pas à ouvrir une issue pour discuter de potentielles améliorations ou corrections.

Licence

Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus de détails.

About

Projet éducatif de générateur de mots de passe en Rust, dans le but d'apprendre les bonnes pratiques.

Topics

Resources

License

Stars

Watchers

Forks

Languages