Si vous desirer debuter dans l'open source, se projet est fait pour vous.
Comment contribuer ?
commencer a fait fork du projet et ensuite cloner votre fork dans votre git locale. ajouter le depot du projet comme depot distant dans votre projet en locale. A chaque fois que vous vouler apporter des modification assurer vous d'obtenir les dernier mise a jour du depot original avant de continuer vos modification. Apres avoir finit votre contribution et pousser votre travail sur la version fork du projet dans votre referentielle git, fait un pull request pour pousser faire une demande d'extraction de votre contribution.
- Repondre au questions des questions des nouveaux utilisateur
- Correction de faute d'orthographe
- prosition d'une meilleur redaction fichier ![README.md]
- proposition d'une meilleur redaction du fichier ![CONTRIBUTING.md]
lib: Est une un bibliotheque python. C'est dans ce dossier que nous allons definir tout les fonction dont nous aurons besoins.
ALX-Header.sh: Est le point d'entrée du programme. Ce script bash prend un fichier comme argument et execute dans l'environement linux le script python main.py en lui passant le fichier comme argument.
main.py: Est le point d'entrée au code python. Il se contente de tramsmettre l'argument file recuperer a la fonction file_type de la bibliotheque lib dans le fichier fileType.py
file_type: Cette fonction determine en un premiers temps le language de programmation de fichier et ensuite appelle la fonction Write_in_the_file(file,comment) le language de programmtion est prix en charge par le projet.
Write_in_the_file(file,comment): est une fonction dans le fichier insertion.py. Elle prend en paramettre deux arguments, le fichier: file et comment: un tableau deux dimensions qui contient les caractere pour commenter dans le fichier. Elle charge en memoire le fichier user_config.json et le diagramme de votre choix (le fichier diagram_ALX est charger pas defaut) respectivement dans les variable user_config et diagram.