=======================================
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 ?
===============================
Pour réaliser des correctifs de bogue dans une version stable,
effectuez vos changements sur la branche ``master``. Ne rajoutez pas
de nouvelle fonctionnalité ou ne changez pas la structure de la base
de données sur cette branche.

Pour rajouter de nouvelles fonctionnalités, effectuez vos changements
sur la branche ``futur``. Contactez l’équipe de développement pour
avoir un avis.

Si jamais vous voulez corriger un bogue sur la branche ``futur`` et
que la branche ``master`` est aussi affecté, n’hésitez-pas à le
rétro-porter.

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-patches_ et
envoyez-les avec git-send-email_. Rebasez vos changements si
nécessaire.

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