Contribuir

Contributions to Jami are always welcome and are much appreciated. There are many ways to contribute to Jami, including:

  • Reporting bugs and issues,

  • Contributing code,

  • Helping package and maintain Jami for a GNU/Linux distribution or other operating system,

  • Contributing to the Jami documentation.

¡Por favor vea abajo para saber cómo empezar a contribuir a Jami!

Informe de errores y problemas

Please see the Bug report guide for step-by-step instructions on how to report any issue you may encounter with Jami.

Código de contribución

To start contributing to Jami, look at the good first issues at: https://git.jami.net/groups/savoirfairelinux/-/issues/?sort=created_date&state=opened&label_name[]=good first issue .

Contact the developers directly by adding a comment on the ticket. This will enable the developers to guide you through the process.

A push with a patch to https://review.jami.net will be required to integrate the code to Jami.

Ver también

For more information on how to push a patch, please refer to the Working with Gerrit guide.

Pautas de confirmación de mensajes

When submitting a patch to Jami, please follow the following guidelines for the commit messages:

  1. The first line should include the component or scope of the change, followed by a short summary of the change in the imperative mood (e.g., «add new function», «fix bug», «update documentation»).

  2. El asunto puede usar las mayúsculas del componente o alcance, pero el resto del título debe estar en minúsculas.

  3. La segunda línea debe estar en blanco.

  4. La tercera línea debe ser el comienzo de una descripción más larga del cambio en oraciones completas, si es necesario.

  5. regla 50/72: La primera línea no debe tener más de 50 caracteres (idealmente), y el resto del mensaje debe ajustarse a 72 caracteres por línea. Esto se puede configurar en su editor de texto.

  6. If the change is related to a specific issue in the Jami GitLab, include the issue number in the commit message. For example: GitLab: #123. If the change is related to multiple issues, list them all. If the change is related to an issue that is not part of the project, use a link to the issue instead.

Plantilla para un mensaje de confirmación:

<Component/Scope>: <short Summary (imperative, max 50 characters)>

<Detailed description (in present tense) of what was changed and why
it was necessary, wrapped at 72 characters per line to maintain
readability. Include any important details that help others understand
the context of the change. Use this space to explain complex changes
or provide background information.>

[GitLab: #<issuenumber>] or [Link to issue]

Por ejemplo:

ConversationView: add a new function

Adds a new function to the ConversationView class that allows
the user to sort conversations by date. This function is necessary
to improve the user experience and make it easier to find specific
conversations.

GitLab: #123

Envasado Jami

There are two possible ways to package Jami:

  1. Via our internal process to create packages available on the Snap Store or https://dl.jami.net.

  2. Via the packaging process of your favorite GNU/Linux distribution.

Importante

Jami is a quite complex project with a lot of dependencies. This isn’t a quick and easy task and requires maintenance.

Nota

If Jami is packaged using the second option:

  • For official releases, Jami uses certain Qt versions because Qt is a big dependency. This is to ensure that Jami works with the Qt version in use. Every slight change in the Qt version can break Jami or bring some small unwanted changes. For example, 6.2 → 6.4 broke the video pipeline.

  • Jami uses a fork of the pjproject, as ICE over TCP is a requirement that is not planned upstream.

  • libupnp received some patches to ensure that it’s built with the non-blocking API.

  • FFmpeg has some screen sharing patches.

  • Visit daemon/contrib/src to check how dependencies are built.

For internal packaging, everything is located in extras/packaging/gnu-linux. You can follow previous patches to understand your needs. e.g., https://review.jami.net/c/jami-client-qt/+/28036.

Jami has 3 release channels:

  • Internal for testing purposes

  • Nightly/Beta/Edge for public beta

  • Stable for public releases

The internal channel is generally used to test new distributions or when a new Qt version is packaged. Then a nightly is generated once per week, and a stable is generated once per month (if unit tests are green).

Packages are pushed to:

To add a distribution:

  • Add Dockerfile

  • Change Makefile

  • Update packaging script

  • Cross fingers

  • Test the package in a VM

Advertencia

Chromium es una parte difícil de construir. Se han encontrado tres problemas comunes:

  • GCC es demasiado reciente:

    • En general, la solución consiste en importar parches de Gerrit de Chromium para solucionar problemas de GCC

  • Python es demasiado reciente:

    • Generalmente, la solución consiste en usar PyEnv para obtener un entorno virtual con la versión correcta de Python

  • Dependencias que faltan:

    • Durante el paso de configuración de Qt, se enumera la lista de componentes construidos y se enumeran las dependencias que faltan. Generalmente instalando un paquete o actualizando nodo.js soluciona el problema

    • Note that if Qt is generated without Chromium, Chromium must be removed from the package in the cache of the build machines to regenerate a new one (/var/cache/jami)

To remove a distribution:

  • If a distribution is EOL OR if there are 2 more recent LTS, the distribution can be removed (e.g., Ubuntu 20, 22, 24—remove Ubuntu 20) by removing related files and checks.

Nota

The next big changes required are:

  • Use CMake instead of autotools for jami-daemon.

  • Use Ubuntu Core 22 (UC22) instead of core20 in snap.

  • Flatpak/AppImage support? This may simplify custom RPM/Debian packaging.

  • Only generate one unified Debian installation file and one unified RPM installation file.

  • Use Jenkinsfile to generate packages for GNU/Linux, macOS, and Windows at the same time if possible.

For internal information (such as how to publish to stores, cf. internal wiki).

Contribución a esta documentación

Las contribuciones a estos documentos son siempre bienvenidas y apreciadas, desde pequeñas correcciones hasta capítulos completamente nuevos.

This page will walk through the steps to create a new page or submit a correction. The patch review process is the same as for any other Jami project, so every command will not be explained.

Nota

By contributing to this documentation, you agree to make your contributions available under the fdl, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.

You are also promising that you are the author of your changes, or that you copied them from a work in the public domain or a work released under a free license that is compatible with the fdl. DO NOT SUBMIT COPYRIGHTED WORK WITHOUT PERMISSION.

Ver también

If you want to help to translate this page, you can join the project and start translating this page on https://explore.transifex.com/savoirfairelinux/.

Dependencias

Git is required to be installed and configured to use your SSH keypair and an account on the Jami Gerrit, where you would send your patches for review. If you need help with this, see the beginning of our patch submission guide (TODO).

To preview changes locally in a web browser, the following are required to be installed:

$ pip install --upgrade sphinx sphinx_rtd_theme myst_parser

To use the auto-build and the auto-refresh feature, also install sphinx-autobuild.

$ pip install --upgrade sphinx-autobuild

Cloning del repositorio

Clona el repositorio y configure las configuraciones de empuje como esto:

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

You may want to check out a new branch for each contribution/change before you make any change to the files so that you could easily git pull any future changes from upstream into your main local branch:

$ git checkout -b my-example-change

Editar una página

Pages are written in Markdown. Click «View page source» at the top of any page to open the raw source of the page and see how it was written.

Go ahead and make your changes to the .md files.

Revisando su trabajo

Desde la base del repositorio, ejecuta:

$ make clean && make html

You should now be able to view the documentation in your web browser. The homepage is at _build/html/index.html.

Advertencia

This documentation does not currently build with the latest version of Sphinx. Please see this issue on GitLab for a workaround and updates regarding this problem.

Para crear automáticamente la documentación y actualizar su navegador web cada vez que guarde cambios, ejecuta:

$ make clean && make watch

Keep this running in the background, then navigate to http://127.0.0.1:8000 (not the local .html file).

Ahorrar su trabajo

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

Refer to the commit message guidelines for how to write a good commit message.

Presentación de un cambio

The first time you try to push your changes, Gerrit will complain that you don’t have a Change-Id in your commit, and provide an scp command to install the commit hook. After running the command, you should be able to recommit and push your change:

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

Modificar su trabajo

A reviewer may ask you to make changes to your patch before merging it. This is no problem! Simply make the changes, git add them, and run git commit --amend to modify the patch.

Nota

The --amend switch, which is required to tell Git to amend/tweak the existing newest commit rather than making a new commit. This is the workflow for updating a proposed change when using Gerrit.

Añadir una página

If you decide to add a whole new page to the documentation, you must also add it to the toctree directive of that chapter.

For instance, if you added a new page called hosting-jams-on-aws-guide.md to the Jami user manual in the user folder, you should add it in the toctree directive of user/index.md, without the file extension:

```{toctree}
:maxdepth: 1

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