L’objectif de ce guide est de vous aider à contribuer au développement ce ce package.

Règles de codage

Afin que le code soit lisible et reste maintenable, il est important d’avoir un code écrit de manière homogène. Pour ce faire, les contributeurs de ce package suivent autant que possible les conseils proposés dans les ouvrages R packages et Advanced R.

Ce package utilise le Français comme langue principale. Les noms d’objet doivent être écrit en Français en se limitant aux caractères ASCII. Pour une prise en charge correcte des caracètres hors ASCII, tous les fichiers doivent être enregistrés avec l’encodage UTF-8.

Documentation

La documentation interne du package utilise Roxygen 6 ou supérieur. La documentation peut, pour des raisons de facilité de lecture, utiliser la syntaxe markdown en ajoutant le tag @md aux blocs de code utilisant markdown.