Contribuer à Jami

Les contributions à Jami sont toujours les bienvenues et sont très appréciées. Il existe de nombreuses façons de contribuer à Jami, notamment en signalant les bogues et les problèmes, en contribuant au code, en aidant à empaqueter et à maintenir Jami pour votre distribution GNU/Linux ou tout autre système d’exploitation, ainsi qu’en contribuant à cette documentation elle-même.

Veuillez lire ci-dessous pour commencer à contribuer à Jami !

Signaler les bogues et les problèmes.

Veuillez consulter le Guide de déclaration des bugs pour obtenir des instructions étape par étape sur la manière de signaler les bogues et les problèmes que vous rencontrez dans Jami.

Contribuer au code 

À FAIRE

Faire des paquets Jami 

À FAIRE

Contribuer à la documentation 

Les contributions à ces documents sont toujours les bienvenues et appréciées, qu’il s’agisse de petites corrections ou de nouveaux chapitres entiers.

Cette page vous explique les étapes à suivre pour créer une nouvelle page ou soumettre une correction. Le processus de révision des correctifs est le même que :doc:`pour tout autre projet Jami `<how-to-submit-a-patch>, nous n’expliquerons donc pas chaque commande.

Note

En contribuant à cette documentation, vous acceptez de mettre vos contributions à disposition sous la licence GNU Free Documentation License, version 1.3 ou toute autre version ultérieure publiée par la Free Software Foundation ; sans sections invariantes, sans textes de première de couverture et sans textes de quatrième de couverture.

Vous promettez également que vous êtes l’auteur de vos modifications, ou que vous les avez copiées à partir d’une œuvre du domaine public ou d’une œuvre publiée sous une licence libre compatible avec le GNU Free Documentation License. NE SOUMETTEZ PAS DE TRAVAUX PROTÉGÉS PAR LE DROIT D’AUTEUR SANS AUTORISATION.

À FAIRE : localisation

Dépendances 

Vous aurez besoin de Git installé et configuré pour utiliser votre paire de clés SSH, et un compte sur le Jami Gerrit, où vous enverrez vos patchs pour révision. Si vous avez besoin d’aide pour cela, consultez :doc:`le début de notre guide de soumission de patchs<how-to-submit-a-patch> ` (À FAIRE).

Si vous voulez prévisualiser vos modifications localement dans votre navigateur web, vous devez installer Sphinx, le thème Read the Docs Sphinx, et le parseur Markdown MyST.

$ pip install --upgrade sphinx sphinx_rtd_theme myst_parser

Si vous voulez utiliser la fonction de construction automatique et de rafraîchissement automatique, installez également sphinx-autobuild.

$ pip install --upgrade sphinx-autobuild

Cloner le référentiel 

Clonez le dépôt et configurez les paramètres de poussée comme ceci :

$ git clone "ssh://USERNAME@review.jami.net:29420/jami-docs.git"
$ cd jami-docs
$ git config remote.origin.push HEAD:refs/for/master

Vous pouvez vouloir vérifier une nouvelle branche pour chaque contribution/changement avant d’effectuer tout changement dans les fichiers, de sorte que vous puissiez facilement git pull tout changement futur depuis l’amont dans votre branche locale principale :

$ git checkout -b my-example-change

Éditer une page 

Les pages sont écrites soit en markdown soit en reStructuredText. Vous pouvez cliquer sur « View page source » en haut de n’importe quelle page pour ouvrir la source brute de la page et voir comment elle a été écrite.

Allez-y et faites vos changements dans les fichiers .rst ou .md.

Prévisualisation de votre travail 

Depuis la base du référentiel, exécutez :

$ make clean && make html

Vous devriez maintenant être en mesure de visualiser la documentation dans votre navigateur web. La page d’accueil est à _build/html/index.html.

Note

Cette documentation n’est pas compatible avec la dernière version de sphinx. Veuillez consulter cette question sur GitLab pour une solution de contournement et des mises à jour concernant ce problème.

Pour construire automatiquement la documentation et rafraîchir votre navigateur web à chaque fois que vous enregistrez des modifications, exécutez :

$ make clean && make watch

Laissez le système fonctionner en arrière-plan, puis accédez à http://127.0.0.1:8000 (pas le fichier .html local).

Sauvegarder votre travail 

$ git add source/file/you/edited.md
$ git commit

Votre message de commit devrait ressembler à ceci :

Short summary of your change in present tense

Longer description of your change in complete sentences, if necessary.

Jami GitLab issue numbers (e.g. GitLab: #445), if relevant.

Par exemple :

Add new page section to contribute guide

Add a new section explaining how to add a new page to these docs,
including listing it in the `toctree` directive of the containing
section/folder index.

GitLab: #123

Soumettre un changement 

La première fois que vous essayez de pousser vos changements, Gerrit se plaindra que vous n’avez pas de Change-Id dans votre commit, et fournira une commande scp pour installer le commit hook. Après avoir exécuté la commande, vous devriez être capable de recommencer et de pousser votre changement :

$ git commit --amend --no-edit
$ git push

Modifier votre travail 

Un réviseur peut vous demander d’apporter des modifications à votre patch avant de le fusionner. Ce n’est pas un problème ! Faites simplement les changements, git add, et lancez git commit --amend pour modifier le patch. Notez le commutateur --amend, qui est nécessaire pour dire à git de amender/tweak le dernier commit existant plutôt que de faire un nouveau commit. C’est le flux de travail pour mettre à jour une proposition de changement quand on utilise Gerrit.

Ajouter une page 

Si vous décidez d’ajouter une toute nouvelle page à la documentation, vous devez également l’ajouter à la directive toctree de ce chapitre.

Par exemple, si vous avez ajouté une nouvelle page appelée hosting-jams-on-aws-guide.md au manuel de l’utilisateur de Jami dans le dossier user, vous devez l’ajouter dans la directive toctree de user/index.rst, sans l’extension du fichier :

.. toctree::

   ...
   bug-report-guide
   hosting-jams-on-aws-guide