Skip to content

Contribuer

uurshin edited this page Oct 15, 2023 · 2 revisions

Minotaure est un logiciel open source. Nous vous invitons à contribuer à ses futures versions à travers notamment du code, de la traduction, des tests et de la documentation. N'hésitez pas à nous avertir de bugs ou à nous proposer des évolutions en ouvrant des tickets.

Installation des sources

Pour construire le projet, clonez le puis lancez les commandes suivantes (la commande npm doit être disponible) : npm ci

Ensuite, vous pouvez créer une build pour, au choix :

  • un seul fichier .html auto-suffisant npm run build -- (le fichier index.html pourra être trouvé dans le dossier /dist/single)
  • une arborescence de fichiers avec npm run build -- --mode=multiple (le fichier index.html pourra être trouvé dans le dossier /dist/multiple)

Contributions

Si vous avez des connaissances en développement javascript, mais ne connaissez pas grand chose au développement collaboratif, à git, ou à github spécifiquement, n'hésitez pas à poser des questions dans le forum du dépôt.

Pour contribuer au code :

  • créez un fork du dépôt git
  • piocher dans les tickets du projet ou proposer vos propres améliorations
  • une fois votre code près à être examiné, créez une PR de la branche dev du dépôt
  • les responsables du dépôt examineront votre PR et vous proposerons éventuelles des retouches
  • si votre PR est approuvée, elle sera alors intégrée à la branche dev
  • votre code fera partie du code de la prochaine version sortie

Icônes de l'application

Les icônes utilisés dans ce projet sont injectés dans une webfont produite grâce à : IcoMoon Si un de vos développements nécessite un nouvel icône, importez le fichier icomoon_minotaure.json, effectuez vos modifications puis exportez le projet et la police avant de soumettre vos modifications sur le dépôt. Assurez-vous de ne proposer que des icônes libres de droit.

Clone this wiki locally