# Documentation

# Vue d’ensemble

Mojaloop a dĂ©fini plusieurs standards afin de garantir que la documentation Ă  travers l’ensemble du projet reste cohĂ©rente et Ă  jour.

  • Toute la documentation pertinente pour les contributeurs est conservĂ©e dans le dĂ©pĂŽt "documentation".
  • Le dĂ©pĂŽt "documentation" est synchronisĂ© avec GitBook et tout le contenu est consultable dans un format facilement lisible Ă  l’adresse : https://www.gitbook.com/mojaloop (opens new window)
  • Toute documentation devrait inclure :
    • Vue d’ensemble : contexte mĂ©tier pour expliquer la valeur ou la raison d’ĂȘtre de la page de documentation
    • DĂ©tails : informations de synthĂšse appropriĂ©es pour soutenir la documentation

#

Standards de documentation (opens new window)

# Guide de style de la documentation

Toute nouvelle documentation devrait ĂȘtre conforme Ă  la documentation et aux styles discutĂ©s ici.

# Guide de style du code

# NodeJS

Nous suivons les standard style guidelines (opens new window). Ajoutez npm install standard Ă  votre package.json.

# Java

Pour Java, nous suivons Checkstyle (opens new window). Mesures de qualité du code