Pensez bien à mettre à jour les contenus et les liens de ce fichier pour le nouveau projet ;)

Template pour les projets publics d'Incaya

Ce dépôt sert de template pour les projets publiques d'Incaya. Ce dépôt inclut :

• les fichiers de documentation de base d'un projet open-source (Readme, licence, code de conduite, guide de contribution ...),
• des templates de Pull requests et d'Issues Github,
• des outils pour maintenir une documentation (Hugo et Excalidraw), sous la forme d'un site web statique publié sur Github pages,
• des outils permettant de mettre en place la spécification Conventional Commits et de s'en servir pour maintenir un fichier de CHANGELOG
• un Makefile de base permettant de lancer les commandes courantes du projet (initialisation, démarrage, tests, déploiements ...)

Pré-requis

• Docker
• Docker Compose
• Python en v3 (pour le hook git)

En option pour gérer les releases, vous aurez besoin de :

• cocogitto

Démarrage rapide

Le Makefile devrait idéalement comporter au moins les recettes suivantes :

• help
• install
• start
• test

En savoir plus sur le Makefile :

• Self-Documented Makefile
• The Language Agnostic, All-Purpose, Incredible, Makefile
• What is a Makefile and how does it work?
• Your Makefiles are wrong

On lance l'installation du projet avec :

make install

et on démarre le projet avec :

make start

Le projet est alors disponible:

• http://localhost:xxxx (en fonction du projet)
• la documentation du projet sur http://localhost:1313/nom-du-repo-github
• Excalidraw (pour faire les schémas de documentation) sur http://localhost:3001

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.
• 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 constituent une part importante de la documentation. Mais, et c'est l'un des objectifs de ce template, il est important d'avoir du contexte sur un projet pour s'y investir. Vous trouverez donc une documentation du projet sur la page Github https://incaya.github.io/template-open-project.

Si vous avez besoin d'aide, n'hésitez pas à consulter la page support, le guide de contribution ou encore la page "Architecture"

License

Les projets publics d'Incaya sont sous licence GNU GPLv3