Skip to main content

Introduction

Djehooty is free software designed to help genealogists manage and explore their digital archives. This documentation guides you in contributing to the project and is intended for anyone wishing to participate in the development or improvement of the project, regardless of their profile or level of expertise.

Djehooty is structured around four main Git repositories:

  • Djehooty: main project repository, containing documentation, distribution scripts and Docker image generation.
  • djehooty-frontend: user interface developed in React and TypeScript.
  • djehooty-backend: server and API developed in Go.
  • website: djehooty.org website

How to contribute?​

Whether you are a developer, user or simply interested in the project, your contribution is welcome.

Please read and respect the Code of Conduct to ensure a welcoming and safe environment for everyone.

Reporting a bug or suggesting a feature​

You can help by reporting issues encountered or suggesting new features. To do so:

  1. Create an account on Codeberg.org.
  2. Use the issue tracker of the main repository to submit your request or contribute to an existing discussion.
  3. After validation, your request will be directed to the relevant repository (backend or frontend).

Best practices:

  • Describe the problem or suggestion precisely.
  • Indicate the steps to reproduce a bug, if applicable.
  • Specify your environment (system, browser, version, etc.).

Contributing to the code​

If you wish to contribute to the code (Go or React/TypeScript), you can submit Pull Requests on the relevant repositories. Before starting:

  • Consult the Architecture page to understand the fundamental principles of the project.
  • Read the README file and documentation of each repository.
  • Feel free to discuss your proposal beforehand via a ticket or by contacting me.

Any feedback or comments on the code are appreciated. The Djehooty project is also a space for learning and continuous improvement: your suggestions are welcome.

Contributors​

Djehooty is currently maintained by Yoann Sculo. The project is open to anyone wishing to get involved, either occasionally or in the long term.

Governance​

To date, there are no formalized governance rules. Design, architecture, development and Pull Request reviews are handled by Yoann Sculo. The project organization will naturally evolve with contributions and the arrival of new contributors.

Would you like to join the adventure? Feel free to share your ideas or get in contact!