=======================================
Guide de contribution à celcatsanitizer
=======================================

.. _ref-list:

Liste de diffusion
==================
Le développement se déroule sur la liste de diffusion
``celcatsanitizer [arobase] framalistes [point] org``. Attention, les
messages de cette liste sont archivés publiquement.

Dépôt
=====
Le dépôt se trouve à l’adresse
https://git.pa1ch.fr/alban/celcatsanitizer.git. Clonez-le en local à
l’aide de git_.

Bien que la forge logicielle supporte les *issues* et les *pull
requests*, ces fonctionnalités ne sont pas utilisées pour le
développement de celcatsanitizer.

.. _git: https://git-scm.com/

Sur quelle branche travailler ?
===============================
Basez-vous sur la branche ``master`` de préférence.  Si vos
changements dépendent d’une branche qui n’a pas encore été fusionnée
dans ``master``, basez-vous sur cette branche.  Si vous avez besoin de
plusieurs branches, choisissez une des branches, puis fusionnez les
autres.

N’oubliez pas de `signer vos commits`_ (avec ``Signed-off-by:``). Si
vos patches sont conséquents, n’hésitez pas à rajouter votre nom au
*copyright*.

.. _signer vos commits:
  https://git-scm.com/docs/git-commit#git-commit--s

Envoyer les patches
===================
Envoyez vos patches sur :ref:`la liste de diffusion
<ref-list>`. Formattez vos patches avec git-format-patch_ et
envoyez-les avec git-send-email_. Rebasez vos changements si
nécessaire.

.. _git-format-patch: https://git-scm.com/docs/git-format-patch
.. _git-send-email: https://git-scm.com/docs/git-send-email