Aller au contenu principal

Introduction

Djehooty est un logiciel libre conçu pour accompagner les généalogistes dans la gestion et l’exploration de leurs archives numériques. Cette documentation vous guide dans la contribution au projet et s’adresse à toute personne souhaitant participer au développement ou à l’amélioration du projet, quel que soit son profil ou son niveau d’expertise.

Djehooty est structuré autour de quatre dépôts Git principaux :

  • Djehooty : dépôt principal du projet, contenant de la documentation, les scripts de distribution et la génération de l’image Docker.
  • djehooty-frontend : interface utilisateur développée en React et TypeScript.
  • djehooty-backend : serveur et API développés en Go.
  • website : site web de djehooty.org

Comment contribuer ?

Que vous soyez développeur·euse, utilisateur·trice ou simplement intéressé·e par le projet, votre contribution est la bienvenue.

Merci de lire et de respecter le Code de Conduite afin de garantir un environnement accueillant et sécurisant pour toutes et tous.

Signaler un bug ou suggérer une fonctionnalité

Vous pouvez aider en signalant les problèmes rencontrés ou en proposant de nouvelles fonctionnalités. Pour cela :

  1. Créez un compte sur Codeberg.org.
  2. Utilisez le gestionnaire de tickets du dépôt principal pour soumettre votre demande ou contribuer à une discussion existante.
  3. Après validation, votre demande sera orientée vers le dépôt concerné (backend ou frontend).

Bonnes pratiques :

  • Décrivez précisément le problème ou la suggestion.
  • Indiquez les étapes pour reproduire un bug, le cas échéant.
  • Précisez votre environnement (système, navigateur, version, etc.).

Contribuer au code

Si vous souhaitez contribuer au code (Go ou React/TypeScript), vous pouvez proposer des Pull Requests sur les dépôts concernés. Avant de commencer :

  • Consultez la page Architecture pour comprendre les principes fondamentaux du projet.
  • Lisez le fichier README et la documentation de chaque dépôt.
  • N’hésitez pas à discuter de votre proposition en amont via un ticket ou en me contactant.

Tout retour ou commentaire sur le code est apprécié. Le projet Djehooty est aussi un espace d’apprentissage et d’amélioration continue : vos suggestions sont les bienvenues.

Contributeurs

Djehooty est actuellement maintenu par Yoann Sculo. Le projet est ouvert à toute personne souhaitant s’impliquer, ponctuellement ou sur le long terme.

Gouvernance

À ce jour, il n’existe pas de règles de gouvernance formalisées. Le design, l’architecture, le développement et la revue des Pull Requests sont assurés par Yoann Sculo. L’organisation du projet évoluera naturellement au fil des contributions et de l’arrivée de nouveaux contributeur·trice·s.

Vous souhaitez rejoindre l’aventure ? N’hésitez pas à proposer vos idées ou à prendre contact!