Skip to content

Latest commit

 

History

History
26 lines (16 loc) · 1.43 KB

contribute_guide.md

File metadata and controls

26 lines (16 loc) · 1.43 KB

CAUTION : This page is in french only

Bonjour petit agrume ! Tu trouveras ici quelques ressources pour t'aider à contribuer à Acid, le petit langage de la communauté de Zeste de Savoir.

N'oublis pas que Acid est inspiré du langage lisp. Participe à la définitions des specs, et implémente le comme tu veut. Si tu as besoin d'aide réfère toi au sujet dédié à Acid sur le forum de Zeste de Savoir ou ouvre une issue sur GitHub.

Liens utiles

Conseils pour les implémentations

Après une discussion sur le forum, il a été choisi de suivre une règle pour documenter son code.

Cette règle se divise en plusieurs parties :

  • De commenter le code en anglais lorsque c'est utile
  • De créer un fichier README.md à chaque répertoire, il explique le fonctionnement global du module concerné et peut potentiellement ajouter des définitions et autres ressources pour mieux introduire le sujet.
  • D'indiquer ou d'ajouter le nom des contributeur à la fin de la Docstring de chaque modules avec cette syntaxe :

Contributors: [pseudo Github] ou ZDS:[pseudo Zeste de Savoir]

Il est recommandé de suivre un maximum cette règle dans les repository d'implémentations, mais il n'est pas forcément nessecaire d'appliquer la règle en totalité.