Comment contribuer

Comment contribuer à Weam.

Contributions #

Les contributions doivent respecter les étapes suivantes :

• Créer une branche
• Ajouter les commits
• Ouvrir une pull request
• Échanges et revue du code
• Déploiement en production
• Merge

Il s’agit du processus de développement conseillé par Github, dont vous pouvez retrouver les détails sur cette page.

Si vous n’êtes pas encore contributeur mais que vous souhaitez contribuer régulièrement au projet, vous pouvez faire la demande de ce statut sur le serveur discord pour accéder à plus de ressources et échanger avec les autres membres de l’équipe.

Si vous n’êtes pas contributeur mais que vous souhaitez tout de même contribuer au projet, vous pouvez nous soumettre vos pull requests ! Celles-ci devront contenir une description détaillant les modifications apportées au projet et seront toutes soumises à une revue de code avant d’être acceptées.

Report de bugs & issues #

Si vous rencontrez une issue ou un bug lors de l’utilisation de la plateforme ou en analysant le code, mais que vous n’êtes pas contributeur, deux solutions sont possibles :

• Vous pouvez reporter ce bug directement sur le dépôt github en ouvrant une issue.
• Vous pouvez corriger ce bug en ouvrant une pull request et en suivant la procédure décrite ci-dessus.

Licences #

Le projet est développé sous licence AGPL.

Ce blog et sa documentation sont écrits sous licence Creative Commons by ND. Les conditions de partage sont disponibles sur cette page.

Développement de l’application #

• Commenter à minima de manière succincte le rôle des fonctions développées.
• Le développement de l’API doit respecter le principe d’API stateless, avec une absence de mémoire entre les différentes requêtes :
  • GET : retour de données sélectionnées
  • POST : persistance de données non-existantes
  • PUT : modification de données pré-existantes
  • DELETE : suppression de données