README.md

Template pour les projets des Caen.Camp.s

Ce dépôt peut servir de template lorsque vous créez un nouveau projet Coding Caen.Camp.

Démarrage rapide

Une description rapide des pré-requis sur l'environnement local permettant de lancer un make install.

Le Makefile devra toujours comporter au moins les recettes suivantes :

• help
• install
• start
• test

Vous trouverez plus d'informations sur les Makefile sur le guide des Coding Caen.Camp.

make install

et lancer le projet avec :

make start

Le projet est alors disponible sur http://localhost:xxxx

Participer au projet

Vous souhaitez participer ? Merci à vous 👍

Et c’est très simple :

• Si vous ne savez pas par où commencer, vous pouvez jeter un coup d’œil aux issues.
• Voir les cartes des fonctionnalités à développer sur tableau Kanban du projet.
• Une fois que vous savez quoi faire, vous pouvez consulter le guide du contributeur pour vous lancer.

Et si vous ne trouvez toujours pas quoi faire dans les issues existantes et/ou que vous avez d’autres idées, n’hésitez pas à créer une nouvelle issue.

Trouver de la documentation

Certes, le code et ses tests sont la meilleur documentation.

Pour autant, le code ne fait pas tous le projet. Vous trouverez donc, en plus de code, des informations sur le projet dans :

• le guide du contributeur
• le wiki du projet
• les ADR.s (notes sur les décisions d'architecture)

Si vous ne savez pas trop comment participer à un projet open-source, vous pouvez aussi jeter un oeil sur notre "Petit guide de participation aux projets des CaenCamp.s pour ceux qui ne saurait pas trop par où commencer."

License

Les projets des Coding Caen.Camp.s sont sous license GNU GPLv3