@node Contribuer
@chapter Contribuer

Ce projet est un effort coopératif et nous avons besoin de votre aide pour
le faire grandir ! Contactez-nous sur @email{guix-devel@@gnu.org} et
@code{#guix} sur le réseau IRC Freenode.  Nous accueillons les idées, les
rapports de bogues, les correctifs et tout ce qui pourrait aider le projet.
Nous apprécions particulièrement toute aide sur la création de paquets
(@pxref{Consignes d'empaquetage}).

@cindex code de conduite, des contributeur·rices
@cindex convention de contribution
Nous souhaitons fournir un environnement chaleureux, amical et sans
harcèlement pour que tout le monde puisse contribuer au mieux de ses
capacités.  Pour cela notre projet a une « Convention de contribution »
adaptée de @url{http://contributor-covenant.org/}.  Vous pouvez trouver une
version locale dans le fichier @file{CODE-OF-CONDUCT} dans l'arborescence
des sources.

Les contributeur·rice·s n'ont pas besoin d'utiliser leur nom légal dans
leurs correctifs et leurs communications en ligne ; elles et ils peuvent
utiliser n'importe quel nom ou pseudonyme de leur choix.

@menu
* Construire depuis Git::    Toujours le plus récent.
* Lancer Guix avant qu'il ne soit installé::  Astuces pour les hackers.
* La configuration parfaite::  Les bons outils.
* Consignes d'empaquetage::  Faire grandir la distribution.
* Style de code::            Hygiène des contributeur·rice·s.
* Envoyer des correctifs::   Partager votre travail.
* Suivi des bogues et des correctifs::  Utiliser Debbugs.
* Accès en commit::         Pousser sur le dépôt officiel.
* Mettre à jour Guix::      Mettre à jour les définitions de paquets de 
                               Guix.
@end menu

@node Construire depuis Git
@section Construire depuis Git

Si vous souhaitez travailler sur Guix lui-même, il est recommandé d'utiliser
la dernière version du dépôt Git :

@example
git clone https://git.savannah.gnu.org/git/guix.git
@end example

@cindex authentification, d'un extrait de Guix
Comment vous assurer que vous avez obtenu une copie authentique du dépôt ?
Pour celà, exécutez @command{guix git authenticate}, en lui transmettant le
commit et l'empreinte OpenPGP de l'@dfn{canal introduction} (@pxref{Invoquer
guix git authenticate}) :

@c ===========================================================================
@c
@c This file was generated with po4a. Translate the source file.
@c
@c ===========================================================================

@c The commit and fingerprint below must match those of the channel
@c introduction in '%default-channels'.
@example
git fetch origin keyring:keyring
guix git authenticate 9edb3f66fd807b096b48283debdcddccfea34bad \
  "BBB0 2DDF 2CEA F6A8 0D1D  E643 A2A0 6DF2 A33A 54FA"
@end example

@noindent
Cette commande se termine avec le code de sortie zéro en cas de succès ;
elle affiche un message d'erreur et quitte avec un code non zéro dans le cas
contraire.

Comme vous pouvez le voir, il y a un problème de poule et d'œuf : il faut
d'abord avoir installé Guix.  En général, vous installez Guix System
(@pxref{Installation du système}) ou Guix sur une autre distribution
(@pxref{Installation binaire}) ; dans les deux cas, vous vérifiez la
signature OpenPGP sur le support d'installation.  Cela "amorce" la chaîne de
confiance.

La manière la plus simple de configurer un environnement de développement
pour Guix est, bien sûr, d'utiliser Guix ! La commande suivante démarre un
nouveau shell où toutes les dépendances et les variables d'environnements
appropriées sont configurés pour travailler sur Guix :

@example
guix environment guix --pure
@end example

@xref{Invoquer guix environment}, pour plus d'informations.

Si vous ne pouvez pas utiliser Guix pour la construction de Guix depuis un
extrait, les paquets suivants sont requis en plus de ceux mentionnés dans
les instructions d'installation (@pxref{Prérequis}).

@itemize
@item @url{https://gnu.org/software/autoconf/, GNU Autoconf} ;
@item @url{https://gnu.org/software/automake/, GNU Automake} ;
@item @url{https://gnu.org/software/gettext/, GNU Gettext} ;
@item @url{https://gnu.org/software/texinfo/, GNU Texinfo} ;
@item @url{https://www.graphviz.org/, Graphviz} ;
@item @url{https://www.gnu.org/software/help2man/, GNU Help2man (facultatif)}.
@end itemize

Avec Guix, vous pouvez ajouter des dépendances supplémentaires en lançant
@command{guix environment} avec @option{--ad-hoc} :

@example
guix environment guix --pure --ad-hoc help2man git strace
@end example

Lancez @command{./bootstrap} pour générer l'infrastructure du système de
construction avec Autoconf et Automake.  Si vous avez une erreur comme :

@example
configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES
@end example

@noindent
cela signifie probablement qu'Autoconf n'a pas pu trouver @file{pkg.m4} qui
est fournit par pkg-config.  Assurez-vous que @file{pkg.m4} est disponible.
C'est aussi vrai pour l'ensemble de macros de @file{guile.m4} fournies par
Guile.  Par exemple, si vous avez installé Automake dans @file{/usr/local},
il ne cherchera pas les fichiers @file{.m4} dans @file{/usr/share}.  Dans ce
case vous devez invoquer la commande suivante :

@example
export ACLOCAL_PATH=/usr/share/aclocal
@end example

@xref{Macro Search Path,,, automake, The GNU Automake Manual}, pour plus
d'information.

Ensuite, lancez @command{./configure} comme d'habitude.  Assurez-vous de
passer @code{--localstatedir=@var{directory}} où @var{directory} est la
valeur @code{localstatedir} utilisée par votre installation actuelle
(@pxref{Le dépôt} pour plus d'informations à ce propos), habituellement
@file{/var}. Remarquez que vous n'allez probablement pas lancer
@command{make install} à la fin (vous n'avez pas besoin de la faire) mais il
est toujours important de passer le bon @code{localstatedir}.

Finalement, vous devez invoquer @code{make && make check} pour construire
Guix et lancer les tests (@pxref{Lancer la suite de tests}).  Si quelque
chose échoue, jetez un œil aux instructions d'installation
(@pxref{Installation}) ou envoyez un message à la liste
@email{guix-devel@@gnu.org}.

À partir de maintenant, vous pouvez authentifier tous les commits de votre
extrait en lançant :

@example
make authenticate
@end example

La première exécution prend quelques minutes, mais les exécutions suivantes
seront plus rapides.

Ou bien, si la configuration de votre dépôt Git local ne correspond pas à la
configuration par défaut, vous pouvez fournir la référence pour la branche
@code{keyring} dans la variable @code{GUIX_GIT_KEYRING}.  L'exemple suivant
suppose que vous avez un dépôt distant nommé @samp{myremote} qui pointe vers
le dépôt officiel :

@example
make authenticate GUIX_GIT_KEYRING=myremote/keyring
@end example

@quotation Remarque
Nous vous conseillons d'exécuter @command{make authenticate} après chaque
invocation de @command{git pull}.  Celà vous garantit de continuer à
recevoir des modifications valables dans le dépôt.
@end quotation


@node Lancer Guix avant qu'il ne soit installé
@section Lancer Guix avant qu'il ne soit installé

Pour garder un environnement de travail sain, il est utile de tester les
changement localement sans les installer pour de vrai.  Pour pouvoir
distinguer votre rôle « d'utilisateur·rice final·e » de celui parfois haut
en couleur de « développeur·euse ».

Pour cela, tous les outils en ligne de commande sont utilisables même sans
avoir lancé @code{make install}.  Pour faire cela, vous devez d'abord avoir
un environnement avec toutes les dépendances disponibles (@pxref{Construire depuis Git}), et puis préfixer simplement chaque commande avec
@command{./pre-inst-env} (le script @file{pre-inst-env} se trouve dans le
répertoire de plus haut niveau de l'arborescence des sources de Guix ; il
est généré en lançant @command{./bootstrap} suivit de
@command{./configure}).  À titre d'exemple, voici comment construire le
paquet @code{hello} tel que défini dans votre arborescence de travail (cela
suppose que @command{guix-daemon} fonctionne déjà sur votre système ; c'est
OK si c'est une version différente) :

@example
$ ./pre-inst-env guix build hello 
@end example

@noindent
De même, pour une session Guile qui utilise les modules Guix :

@example
$ ./pre-inst-env guile -c '(use-modules (guix utils)) (pk (%current-system))'

;;; ("x86_64-linux")
@end example

@noindent
@cindex REPL
@cindex read-eval-print loop
@dots{} et pour une REPL (@pxref{Using Guile Interactively,,, guile, Guile
Reference Manual}) :

@example
$ ./pre-inst-env guile
scheme@@(guile-user)> ,use(guix)
scheme@@(guile-user)> ,use(gnu)
scheme@@(guile-user)> (define snakes
                       (fold-packages
                         (lambda (package lst)
                           (if (string-prefix? "python"
                                               (package-name package))
                               (cons package lst)
                               lst))
                         '()))
scheme@@(guile-user)> (length snakes)
$1 = 361
@end example

Si vous travaillez sur le démon et son code supporté ou si
@command{guix-daemon} n'est pas déjà lancé sur votre système, vous pouvez le
lancer directement depuis l'arborescence de construction@footnote{Le drapeau
@option{-E} de @command{sudo} garantit que @code{GUILE_LOAD_PATH} est
correctement configuré de sorte que @command{guix-daemon} et les outils
qu'il utilise puissent trouver les modules Guile dont ils ont besoin.} :

@example
$ sudo -E ./pre-inst-env guix-daemon --build-users-group=guixbuild
@end example

Le script @command{pre-inst-env} paramètre toutes les variables
d'environnement nécessaires, dont @env{PATH} et @env{GUILE_LOAD_PATH}.

Remarquez que @command{./pre-inst-env guix pull} ne met @emph{pas} à jour
l'arborescence des sources locale ; cela met seulement à jour le lien
symbolique de @file{~/.config/guix/current} (@pxref{Invoquer guix pull}).
Lancez @command{git pull} à la place si vous voulez mettre à jour votre
arborescence des source locale.


@node La configuration parfaite
@section La configuration parfaite

La configuration parfaite pour travailler sur Guix est simplement la
configuration parfaite pour travailler en Guile (@pxref{Using Guile in
Emacs,,, guile, Guile Reference Manual}).  Tout d'abord, vous avez besoin de
mieux qu'un éditeur de texte, vous avez besoin de
@url{http://www.gnu.org/software/emacs, Emacs}, amélioré par le superbe
@url{http://nongnu.org/geiser/, Geiser}.  Pour paramétrer cela, lancez :

@example
guix package -i emacs guile emacs-geiser
@end example

Geiser permet le développement interactif et incrémental depuis Emacs : la
compilation du code et son évaluation depuis les buffers, l'accès à la
documentation en ligne (docstrings), la complétion sensible au contexte,
@kbd{M-.} pour sauter à la définition d'un objet, un REPL pour tester votre
code, et bien plus (@pxref{Introduction,,, geiser, Geiser User Manual}).
Pour travailler confortablement sur Guix, assurez-vous de modifier le chemin
de chargement de Guile pour qu'il trouve les fichiers source de votre dépôt
:

@lisp
;; @r{Si l'extrait est dans ~/src/guix.}
(with-eval-after-load 'geiser-guile
  (add-to-list 'geiser-guile-load-path "~/src/guix"))
@end lisp

Pour effectivement éditer le code, Emacs a déjà un très bon mode Scheme.
Mais en plus de ça, vous ne devez pas rater
@url{http://www.emacswiki.org/emacs/ParEdit, Paredit}.  Il fournit des
fonctionnalités pour opérer directement sur l'arbre de syntaxe, comme
relever une s-expression ou l'envelopper, absorber ou rejeter la
s-expression suivante, etc.

@cindex extraits de code
@cindex modèles
@cindex réduire la quantité de code commun
Nous fournissons aussi des modèles pour les messages de commit git courants
et les définitions de paquets dans le répertoire @file{etc/snippets}.  Ces
modèles s'utilisent avec @url{http://joaotavora.github.io/yasnippet/,
YASnippet} pour développer de courtes chaînes de déclenchement en extraits
de texte interactifs.  Vous pouvez ajouter le répertoire des modèles dans la
variables @var{yas-snippet-dirs} d'Emacs.

@lisp
;; @r{Si l'extrait est dans ~/src/guix.}
(with-eval-after-load 'yasnippet
  (add-to-list 'yas-snippet-dirs "~/src/guix/etc/snippets"))
@end lisp

Les extraits de messages de commit dépendent de @url{https://magit.vc/,
Magit} pour afficher les fichiers sélectionnés.  Lors de la modification
d'un message de commit, tapez @code{add} suivi de @kbd{TAB} pour insérer un
modèle de message de commit pour ajouter un paquet ; tapez @code{update}
suivi de @kbd{TAB} pour insérer un modèle pour la mise à jour d'un paquet ;
tapez @code{https} suivi de @kbd{TAB} pour insérer un modèle pour le
changement à HTTPS de l'URI de la page d'accueil.

L'extrait principal pour @code{scheme-mode} est lancé en tapant
@code{package…} suivi par @kbd{TAB}.  Cet extrait insère aussi la chaîne de
déclenchement @code{origin…}, qui peut aussi être étendue.  L'extrait
@code{origin} lui-même peut aussi insérer des chaînes de déclenchement qui
finissent sur @code{…}, qui peuvent aussi être étendues.

@cindex insérer ou mettre à jour la ligne de copyright
@cindex @code{M-x guix-copyright}
@cindex @code{M-x copyright-update}
De plus, nous fournissons l'insertion et la mise à jour automatique d'une
ligne de copyright dans @file{etc/copyright.el}.  Vous voudrez sans doute
indiquer votre nom complet, adresse de courriel et charger le fichier.

@lisp
(setq user-full-name "Alice Doe")
(setq user-mail-address "alice@@mail.org")
;; @r{En supposant que le dépôt Guix est dans ~/src/guix.}
(load-file "~/src/guix/etc/copyright.el")
@end lisp

Pour insérer une ligne de copyright à la ligne actuelle invoquez @code{M-x
guix-copyright}.

Pour mettre à jour une ligne de copyright vous devez spécifier un
@code{copyright-names-regexp}.

@lisp
(setq copyright-names-regexp
      (format "%s <%s>" user-full-name user-mail-address))
@end lisp

Vous pouvez vérifier si votre ligne de copyright est à jour en évaluant
@code{M-x copyright-update}.  Si vous voulez le faire automatiquement après
chaque sauvegarde de tampon ajoutez @code{(add-hook 'after-save-hook
'copyright-update)} dans Emacs.

@node Consignes d'empaquetage
@section Consignes d'empaquetage

@cindex paquets, création
La distribution GNU est jeune et vos paquets préférés peuvent manquer.
Cette section décrit comment vous pouvez aider à agrandir la distribution.

Les paquets de logiciels libres sont habituellement distribués sous forme
@dfn{d'archives de sources} — typiquement des fichiers @file{.tar.gz}
contenant tous les fichiers sources.  Ajouter un paquet à la distribution
signifie en substance deux choses : ajouter une @dfn{recette} qui décrit
comment construire le paquet, avec une liste d'autres paquets requis pour le
construire, et ajouter des @dfn{métadonnées de paquet} avec la recette,
comme une description et une licence.

Dans Guix, toutes ces informations sont incorporées dans les
@dfn{définitions de paquets}.  Les définitions de paquets fournissent une
vue de haut-niveau du paquet.  Elles sont écrites avec la syntaxe du langage
de programmation Scheme ; en fait, pour chaque paquet nous définissons une
variable liée à la définition et exportons cette variable à partir d'un
module (@pxref{Modules de paquets}).  Cependant, il n'est @emph{pas} nécessaire
d'avoir une connaissance approfondie du Scheme pour créer des paquets.  Pour
plus d'informations sur les définitions des paquets, @pxref{Définition des paquets}.

Une fois une définition de paquet en place, stocké dans un fichier de
l'arborescence des sources de Guix, il peut être testé avec la commande
@command{guix build} (@pxref{Invoquer guix build}).  Par exemple, en
supposant que le nouveau paquet s'appelle @code{gnew}, vous pouvez lancer
cette commande depuis l'arborescence de construction de Guix (@pxref{Lancer Guix avant qu'il ne soit installé}) :

@example
./pre-inst-env guix build gnew --keep-failed
@end example

Utiliser @code{--keep-failed} rend facile le débogage des échecs car il
fournit l'accès à l'arborescence de construction qui a échouée.  Une autre
sous-commande utile pour le débogage est @code{--log-file}, pour accéder au
journal de construction.

Si le paquet n'est pas connu de la commande @command{guix}, il se peut que
le fichier source ait une erreur de syntaxe, ou qu'il manque une clause
@code{define-public} pour exporter la variable du paquet.  Pour comprendre
cela, vous pouvez charger le module depuis Guile pour avoir plus
d'informations sur la véritable erreur :

@example
./pre-inst-env guile -c '(use-modules (gnu packages gnew))'
@end example

Une fois que votre paquet est correctement construit, envoyez-nous un
correctif (@pxref{Contribuer}).  Enfin, si vous avez besoin d'aide, nous
serons ravis de vous aider aussi.  Une fois que le correctif soumis est
commité dans le dépôt Guix, le nouveau paquet est automatiquement construit
sur les plate-formes supportées par @url{@value{SUBSTITUTE-SERVER}, notre
système d'intégration continue}.

@cindex substitution
On peut obtenir la nouvelle définition du paquet simplement en lançant
@command{guix pull} (@pxref{Invoquer guix pull}). Lorsque
@code{@value{SUBSTITUTE-SERVER}} a fini de construire le paquet,
l'installation du paquet y télécharge automatiquement les binaires
(@pxref{Substituts}). La seule intervention humaine requise est pendant la
revue et l'application du correctif.


@menu
* Liberté logiciel::        Ce que la distribution peut contenir.
* Conventions de nommage::   Qu'est-ce qu'un bon nom ?
* Numéros de version::      Lorsque le nom n'est pas suffisant.
* Synopsis et descriptions::  Aider les utilisateur·rice·s à trouver le 
                                bon paquet.
* Substituts ou Phases::     Qu'il s'agisse d'un substitut ou d'une phase de 
                               construction.
* Paquets emacs::            Votre dose d'Elisp.
* Modules python::           Un peu de comédie anglaise.
* Modules perl::             Petites perles.
* Paquets java::             Pause café.
* Paquets Rust::             Attention à l'oxydation.
* Polices de caractères::   À fond les fontes.
@end menu

@node Liberté logiciel
@subsection Liberté logiciel

@c Adapted from http://www.gnu.org/philosophy/philosophy.html.
@cindex logiciel libre
Le système d'exploitation GNU a été développé pour que les utilisatrices et
utilisateurs puissent utiliser leur ordinateur en toute liberté.  GNU est un
@dfn{logiciel libre}, ce qui signifie que chaque personne l'utilisant
bénéficie des @url{https://www.gnu.org/philosophy/free-sw.fr.html,quatre
libertés essentielles} : exécuter le programmer, étudier et modifier le
programme sous sa forme source, redistribuer des copies exactes et
distribuer les versions modifiées.  Les paquets qui se trouvent dans la
distribution GNU ne fournissent que des logiciels qui respectent ces quatre
libertés.

En plus, la distribution GNU suit les
@url{https://www.gnu.org/distros/free-system-distribution-guidelines.html,recommandations
pour les distributions systèmes libres}.  Entre autres choses, ces
recommandations rejettent les microgiciels non libres, les recommandations
de logiciels non libres et discute des façon de gérer les marques et les
brevets.

Certaines sources amont autrement parfaitement libres contiennent une petite
partie facultative qui viole les recommandations ci-dessus, par exemple car
cette partie est du code non-libre.  Lorsque cela arrive, les éléments en
question sont supprimés avec des correctifs ou des bouts de codes appropriés
dans la forme @code{origin} du paquet (@pxref{Définition des paquets}).  De cette
manière, @code{guix build --source} renvoie la source « libérée » plutôt que
la source amont sans modification.


@node Conventions de nommage
@subsection Conventions de nommage

@cindex nom du paquet
Un paquet a en fait deux noms qui lui sont associés. Premièrement il y a le
nom de la @emph{variable Scheme}, celui qui suit @code{define-public}.  Par
ce nom, le paquet peut se faire connaître par le code Scheme, par exemple
comme entrée d'un autre paquet.  Deuxièmement, il y a la chaîne dans le
champ @code{name} d'une définition de paquet.  Ce nom est utilisé par les
commandes de gestion des paquets comme @command{guix package} et
@command{guix build}.

Les deux sont habituellement les mêmes et correspondent à la conversion en
minuscule du nom du projet choisi en amont, où les underscores sont
remplacés par des tirets.  Par exemple, GNUnet est disponible en tant que
@code{gnunet} et SDL_net en tant que @code{sdl-net}.

Une exception notable à cette règle est lorsque le nom du projet consiste en
un unique caractère, ou si un projet maintenu plus ancien avec le même nom
existe déjà — indépendamment de s'il a été empaqueté dans Guix on
nom. Utilisez votre bon sens pour éviter de rendre ces noms ambigües et de
leur enlever leur sens. Par exemple, le paquet Guix pour le shell nommé « s
» en amont est @code{s-shell} et @emph{pas} @code{s}. N'hésitez pas à
demander si vous êtes en panne d'inspiration.

Nous n'ajoutons pas de préfixe @code{lib} au bibliothèques de paquets, à
moins qu'il ne fasse partie du nom officiel du projet.  Mais @pxref{Modules python} et @ref{Modules perl}  pour des règles spéciales concernant les
modules pour les langages Python et Perl.

Les noms de paquets de polices sont gérés différemment, @pxref{Polices de caractères}.


@node Numéros de version
@subsection Numéros de version

@cindex version du paquet
Nous n'incluons en général que la dernière version d'un projet de logiciel
libre donné.  Mais parfois, par exemple pour des versions incompatibles de
bibliothèques, deux (ou plus) versions du même paquet sont requises.  Elles
ont besoin d'un nom de variable Scheme différent.  Nous utilisons le nom
défini dans @ref{Conventions de nommage} pour la version la plus récente ; les
versions précédentes utilisent le même nom, suffixé par @code{-} et le plus
petit préfixe du numéro de version qui permet de distinguer deux versions.

Le nom dans la définition du paquet est le même pour toutes les versions
d'un paquet et ne contient pas de numéro de version.

Par exemple, les version 2.24.20 et 3.9.12 de GTK+ peuvent être inclus de
cette manière :

@lisp
(define-public gtk+
  (package
    (name "gtk+")
    (version "3.9.12")
    ...))
(define-public gtk+-2
  (package
    (name "gtk+")
    (version "2.24.20")
    ...))
@end lisp
Si nous voulons aussi GTK+ 3.8.2, cela serait inclus de cette manière
@lisp
(define-public gtk+-3.8
  (package
    (name "gtk+")
    (version "3.8.2")
    ...))
@end lisp

@c See <https://lists.gnu.org/archive/html/guix-devel/2016-01/msg00425.html>,
@c for a discussion of what follows.
@cindex numéro de version, pour les instantanés des systèmes de contrôle de version
Parfois, nous incluons des paquets provenant d'instantanés de systèmes de
contrôle de version (VCS) au lieu de versions publiées formellement.  Cela
devrait rester exceptionnel, car c'est le rôle des développeurs amont de
spécifier quel est la version stable.  Cependant, c'est parfois nécessaire.
Donc, que faut-il mettre dans le champ @code{version} ?

Clairement, nous devons rendre l'identifiant de commit de l'instantané du
VCS visible dans la version, mais nous devons aussi nous assurer que la
version augmente de manière monotone pour que @command{guix package
--upgrade} puisse déterminer quelle version est la plus récente.  Comme les
identifiants de commits, notamment avec Git, n'augmentent pas, nous ajoutons
un numéro de révision qui nous augmentons à chaque fois que nous mettons à
jour vers un nouvel instantané.  La chaîne qui en résulte ressemble à cela :

@example
2.0.11-3.cabba9e
  ^    ^    ^
  |    |    `-- ID du commit en amont
  |    |
  |    `--- révision du paquet Guix
  |
dernière version en amont
@end example

C'est une bonne idée de tronquer les identifiants dans le champ
@code{version} à disons 7 caractères.  Celà évite un problème esthétique (en
supposant que l'esthétique ait un rôle à jouer ici) et des problèmes avec
les limites de l'OS comme la longueur maximale d'un shebang (127 octets pour
le noyau Linux).  Il vaut mieux cependant utiliser l'identifiant de commit
complet dans @code{origin}, pour éviter les ambiguïtés.  Une définition de
paquet peut ressembler à ceci :

@lisp
(define my-package
  (let ((commit "c3f29bc928d5900971f65965feaae59e1272a3f7")
        (revision "1"))          ;révision du paquet Guix
    (package
      (version (git-version "0.9" revision commit))
      (source (origin
                (method git-fetch)
                (uri (git-reference
                      (url "git://example.org/my-package.git")
                      (commit commit)))
                (sha256 (base32 "1mbikn@dots{}"))
                (file-name (git-file-name name version))))
      ;; @dots{}
      )))
@end lisp

@node Synopsis et descriptions
@subsection Synopsis et descriptions

@cindex description du paquet
@cindex résumé du paquet
Comme nous l'avons vu avant, chaque paquet dans GNU@tie{}Guix contient un
résumé et une description (@pxref{Définition des paquets}).  Les résumés et les
descriptions sont importants : ce sont eux que recherche @command{guix
package --search}, et c'est une source d'informations cruciale pour aider
les utilisateur·rice·s à déterminer si un paquet donné correspond à leurs
besoins.  En conséquence, il convient de prêter attention à leur contenu
lorsqu'on travaille sur un paquet.

Les résumés doivent commencer par une lettre capitale et ne doit pas finir
par un point.  Ils ne doivent pas commencer par « a » ou « the » (« un » ou
« le/la »), ce qui n'apporte généralement rien ; par exemple, préférez «
File-frobbing tool » (« Outil de frobage de fichier ») à « A tool that frobs
file » (« Un outil qui frobe les fichiers »).  Le résumé devrait dire ce que
le paquet est — p.@: ex.@: « Utilitaire du cœur de GNU (fichier, text,
shell) » — ou ce à quoi il sert — p.@: ex.@: le résumé de grep est « Affiche
des lignes correspondant à un motif ».

Gardez à l'esprit que le résumé doit avoir un sens pour une large audience.
Par exemple « Manipulation d'alignements au format SAM » peut avoir du sens
pour un bioinformaticien chevronné, mais n'aidera pas ou pourra perdre une
audience de non-spécialistes.  C'est une bonne idée de créer un résumé qui
donne une idée du domaine d'application du paquet.  Dans cet exemple, cela
donnerait « Manipulation d'alignements de séquences de nucléotides », ce qui
devrait donner une meilleure idée à la personne qui le lit pour savoir si
c'est ce qu'elle recherche.

Les descriptions devraient faire entre cinq et dix lignes.  Utilisez des
phrases complètes, et évitez d'utiliser des acronymes sans les introduire
d'abord.  Évitez les phrases marketings comme « world-leading », «
industrial-strength » et « next-generation » et évitez les superlatifs comme
« the most advanced » — ils ne sont pas utiles aux personnes qui cherchent
un paquet et semblent même un peu suspects.  À la place, essayez d'être
factuels, en mentionnant les cas d'utilisation et les fonctionnalités.

@cindex Balisage texinfo, dans les descriptions de paquets
Les descriptions peuvent inclure du balisage Texinfo, ce qui est utile pour
introduire des ornements comme @code{@@code} ou @code{@@dfn}, des listes à
points ou des hyperliens (@pxref{Overview,,, texinfo, GNU Texinfo}).
Cependant soyez prudents lorsque vous utilisez certains symboles, par
exemple @samp{@@} et les accolades qui sont les caractères spéciaux de base
en Texinfo (@pxref{Special Characters,,, texinfo, GNU Texinfo}).  Les
commandes et outils comme @command{guix package --show} prennent en charge
le rendu.

Les résumés et les descriptions sont traduits par des volontaires
@uref{https://translate.fedoraproject.org/projects/guix/packages, sur
Weblate} pour que le plus de personnes possible puissent les lire dans leur
langue natale.  Les interfaces les recherchent et les affichent dans la
langue spécifiée par le paramètre de régionalisation actuel.

Pour permettre à @command{xgettext} de les extraire comme des chaînes
traduisibles, les résumés et les descriptions @emph{doivent être des chaînes
litérales}.  Cela signifie que vous ne pouvez pas utiliser
@code{string-append} ou @code{format} pour construire ces chaînes :

@lisp
(package
  ;; @dots{}
  (synopsis "Ceci est traduisible")
  (description (string-append "Ceci n'est " "*pas*" " traduisible.")))
@end lisp

La traduction demande beaucoup de travail, faites donc d'autant plus
attention à vos résumés et descriptions lorsque vous développez un paquet
car chaque changement peut demander du de travail de la part des
traducteur·rice·s.  Pour les aider, il est possible de donner des
recommandations ou des instructions qu'ils et elles pourront voir en
insérant des commentaires spéciaux comme ceci (@pxref{xgettext Invocation,,,
gettext, GNU Gettext}) :

@lisp
;; TRANSLATORS: "X11 resize-and-rotate" should not be translated.
(description "ARandR is designed to provide a simple visual front end
for the X11 resize-and-rotate (RandR) extension. @dots{}")
@end lisp

@node Substituts ou Phases
@subsection Substituts ou Phases

@cindex substituts, quand les utiliser
La différence entre l'utilisation d'un bout de code (snippet) dans origin et
une phase de construction pour modifier les sources d'un paquet peut être
particulièrement subtile. Les bouts de code dans origin sont en général
utilisés pour supprimer des fichiers indésirables, comme des bibliothèques
incluses, des sources non libres ou pour appliquer de simples
substitutions. La source dérivée d'un objet origin devrait produire une
source qui peut être utilisée pour construire le paquet sur n'importe quel
système pris en charge par le paquet en amont (c.-à-d.@:, être la source
correspondante). En particulier, les bouts de code dans origin ne doivent
pas inclure d'éléments du dépôt dans les sources ; de telles corrections
devraient plutôt être faites avec une phase de construction. Référez-vous à
la documentation sur l'enregistrement @code{origin} pour plus d'information
(@pxref{référence de origin}).

@node Paquets emacs
@subsection Paquets emacs

@cindex emacs, création de paquets
@cindex elips, création de paquets
Les paquets Emacs devraient plutôt utiliser le système de construction Emacs
(@pxref{emacs-build-system}), pour l'uniformité et les bénéfices apportés
par ses phases de construction, comme la génération automatique du fichier
autoloads et la compilation des sources. Comme il n'y a pas de manière
standardisée de lancer une suite de tests pour les paquets Emacs, les tests
sont désactivés par défaut. Lorsqu'une suite de tests est disponible, elle
devrait être activée en mettant l'argument @code{#:tests?} à
@code{#true}. Par défaut, la commande pour lancer les tests est
@command{make check}, mais on peut spécifier une autre commande via
l'argument @code{#:test-command}. L'argument @code{#:test-command} attend
une liste contenant une commande et ses arguments, à invoquer pendant la
phase @code{check}.

Les dépendances Elisp des paquets Emacs sont en général fournie dans
@code{propagated-inputs} lorsqu'elles sont requises à l'exécution. Comme
pour les autres paquets, les dépendances de test et de construction doivent
être spécifiées dans @code{native-inputs}.

Les paquets Emacs dépendent parfois de répertoires de ressources qui
devraient être installés avec les fichiers Elisp. L'argument
@code{#:include} peut être utilisé pour cela, en spécifiant une liste
d'expression régulières. La bonne pratique pour utiliser l'argument
@code{#:include} est d'étendre plutôt que de remplacer sa valeur par défaut
(accessible via la variable @code{%default-include}). Par exemple, un paquet
d'extension yasnippet inclut en général un répertoire @file{snippets}, qui
pourrait être copié vers le répertoire d'installation avec :

@lisp
#:include (cons "^snippets/" %default-include))
@end lisp

Lorsque vous rencontrez des problèmes, il est utile de vérifier la présence
de l'en-tête d'extension @code{Package-Requires} dans le fichier source
principal du paquet, et si les dépendances et leurs versions qui y sont
listées sont satisfaites.

@node Modules python
@subsection Modules python

@cindex python
Nous incluons actuellement Python 2 et Python 3, sous les noms de variables
Scheme @code{python-2} et @code{python} comme expliqué dans @ref{Numéros de version}.  Pour éviter la confusion et les problèmes de noms avec d'autres
langages de programmation, il semble désirable que le nom d'un paquet pour
un module Python contienne le mot @code{python}.

Certains modules ne sont compatibles qu'avec une version de Python, d'autres
avec les deux.  Si le paquet Foo ne compile qu'avec Ptyhon 3, on le nomme
@code{python-foo}.  S'il est compilé avec Python 2, on le nome
@code{python2-foo}.  Les paquets ne devraient être ajoutés que lorsqu'ils
sont nécessaires ; nous n'ajoutons pas les variantes Python 2 du paquet à
moins qu'on ne les utilise ensuite.

Si un projet contient déjà le mot @code{python}, on l'enlève, par exemple le
module python-dateutil est packagé sous les noms @code{python-dateutil} et
@code{python2-dateutil}.  Si le nom du projet commence par @code{py} (p.@:
ex.@: @code{pytz}), on le garde et on le préfixe comme décrit ci-dessus.

@subsubsection Spécifier les dépendances
@cindex entrées, pour les paquets Python

Les informations de dépendances pour les paquets Python se trouvent
généralement dans l'arborescence des source du paquet, avec plus ou moins de
précision : dans le fichier @file{setup.py}, dans @file{requirements.txt} ou
dans @file{tox.ini}.

Votre mission, lorsque vous écrivez une recette pour un paquet Python, est
de faire correspondre ces dépendances au bon type « d'entrée »
(@pxref{référence de package, inputs}).  Bien que l'importeur @code{pypi} fasse
du bon boulot (@pxref{Invoquer guix import}), vous devriez vérifier la liste
suivant pour déterminer où va telle dépendance.

@itemize

@item
Nous empaquetons Python 2 avec @code{setuptools} et @code{pip} installé
comme Python 3.4 par défaut.  Ainsi, vous n'avez pas à spécifié ces
entrées.  @command{guix lint} vous avertira si vous faîtes cela.

@item
Les dépendances Python requises à l'exécutions vont dans
@code{propagated-inputs}.  Elles sont typiquement définies dans le mot-clef
@code{install_requires} dans @file{setup.py} ou dans le fichier
@file{requirements.txt}.

@item
Les paquets Python requis uniquement à la construction — p.@: ex.@: ceux
listés dans le mot-clef @code{setup_requires} de @file{setup.py} — ou
seulement pour les tests — p.@: ex.@: ceux dans @code{tests_require} — vont
dans @code{native-inputs}.  La raison est qu'ils n'ont pas besoin d'être
propagés car ils ne sont pas requis à l'exécution et dans le cas d'une
compilation croisée, c'est l'entrée « native » qu'il nous faut.

Les cadriciels de tests @code{pytest}, @code{mock} et @code{nose} sont des
exemples.  Bien sûr si l'un de ces paquets est aussi requis à l'exécution,
il doit aller dans @code{propagated-inputs}.

@item
Tout ce qui ne tombe pas dans les catégories précédentes va dans
@code{inputs}, par exemple des programmes pour des bibliothèques C requises
pour construire des paquets Python avec des extensions C.

@item
Si un paquet Python a des dépendances facultatives (@code{extras_require}),
c'est à vous de décider de les ajouter ou non, en fonction du ratio entre
utilité et complexité (@pxref{Envoyer des correctifs, @command{guix size}}).

@end itemize


@node Modules perl
@subsection Modules perl

@cindex perl
Les programmes Perl utiles en soit sont nommés comme les autres paquets,
avec le nom amont en minuscule.  Pour les paquets Perl contenant une seule
classe, nous utilisons le nom de la classe en minuscule, en remplaçant les
occurrences de @code{::} par des tirets et en préfixant le tout par
@code{perl-}.  Donc la classe @code{XML::Parser} devient
@code{perl-xml-parser}.  Les modules contenant plusieurs classes gardent
leur nom amont en minuscule et sont aussi préfixés par @code{perl-}.  Ces
modules tendent à avoir le mot @code{perl} quelque part dans leur nom, que
nous supprimons en faveur du préfixe.  Par exemple, @code{libwww-perl}
devient @code{perl-libwww}.


@node Paquets java
@subsection Paquets java

@cindex java
Le programmes Java utiles en soit sont nommés comme les autres paquets, avec
le nom amont en minuscule.

Pour éviter les confusions et les problèmes de nom avec d'autres langages de
programmation, il est désirable que le nom d'un paquet Java soit préfixé par
@code{java-}.  Si un projet contient déjà le mot @code{java}, nous le
supprimons, par exemple le paquet @code{ngsjava} est empaqueté sous le nom
@code{java-ngs}.

Pour les paquets java contenant une seul classe ou une petite hiérarchie de
classes, nous utilisons le nom de la classe en minuscule, en remplaçant les
occurrences de @code{.} par des tirets et en préfixant le tout par
@code{java-}.  Donc la classe @code{apache.commons.cli} devient
@code{java-apache-commons-cli}.


@node Paquets Rust
@subsection Paquets Rust

@cindex rust
Le programmes Rust utiles en soit sont nommés comme les autres paquets, avec
le nom amont en minuscule.

Pour éviter des collisions de noms nous préfixons les autres paquets avec le
préfixe @code{rust-}.  Vous devrez changer le nom en minuscule et garder les
tirets en place.

Dans l'écosystème rust il est courant d'avoir plusieurs versions
incompatibles d'un paquet utilisées en même temps, donc toutes les
définitions des paquets devraient avoir un suffixe de version. Le suffixe de
version est le nombre le plus à gauche qui n'est pas un zéro (et tous les
zéros précédents, évidemment). Cela suit les conventions de version « caret
» de Cargo. Par exemple @code{rust-clap-2}, @code{rust-rand-0.6}.

À cause de la difficulté à réutiliser des paquets rust en entrées
précompilées pour d'autres paquets, le systèmes de construction Cargo
(@pxref{Systèmes de construction, @code{cargo-build-system}}) présente les mots-clefs
@code{#:cargo-inputs} et @code{cargo-development-inputs} en argument du
système de construction.  Vous pouvez y penser comme les équivalents de
@code{propagated-inputs} et @code{native-inputs}.  Les @code{dependencies}
et @code{build-dependencies} de Rust devraient aller dans
@code{#:cargo-inputs} et @code{dev-dependencies} dans
@code{#:cargo-development-inputs}.  Si un paquet Rust se lie à d'autres
bibliothèques alors vous devriez utiliser l'emplacement @code{inputs}
standard et compagnie.

Vous devriez faire attention à vous assurer que la bonne version des
dépendances est utilisée ; pour cela nous essayons d'éviter de passer les
tests ou d'utiliser @code{#:skip-build?} lorsque c'est possible.  Bien sûr
ce n'est pas toujours possible, comme le paquet peut être développé sur un
autre système d'exploitation, dépendre d'une fonctionnalité du compilateur
Rust Nightly ou la suite de test atrophiée depuis la sortie.


@node Polices de caractères
@subsection Polices de caractères

@cindex polices
Pour les polices qui ne sont en général pas installées pour être utilisées
pour du traitement de texte, ou qui sont distribuées en tant que partie d'un
paquet logiciel plus gros, nous nous appuyons sur les règles générales pour
les logiciels ; par exemple, cela s'applique aux polices livrées avec le
système X.Org ou les polices qui font partie de TeX Live.

Pour rendre plus facile la recherche par l'utilisatrice ou l'utilisateur,
les noms des autres paquets contenant seulement des polices sont construits
ainsi, indépendamment du nom du paquet en amont.

Le nom d'un paquet contenant une unique famille de polices commence par
@code{font-} ; il est suivi du nom du fondeur et d'un tiret @code{-} si le
fondeur est connu, et du nom de la police, dont les espaces sont remplacés
par des tirets (et comme d'habitude, toutes les lettres majuscules sont
transformées en minuscules).  Par exemple, la famille de polices Gentium de
SIL est empaqueté sous le nom @code{font-sil-gentium}.

Pour un paquet contenant plusieurs familles de polices, le nom de la
collection est utilisée à la place du nom de la famille.  Par exemple les
polices Liberation consistent en trois familles, Liberation Sans, Liberation
Serif et Liberation Mono.  Elles pourraient être empaquetées séparément sous
les noms @code{font-liberation-sans} etc, mais comme elles sont distribuées
ensemble sous un nom commun, nous préférons les empaqueter ensemble en tant
que @code{font-liberation}.

Dans le cas où plusieurs formats de la même famille ou collection sont
empaquetés séparément, une forme courte du format, préfixé d'un tiret est
ajouté au nom du paquet.  Nous utilisont @code{-ttf} pour les polices
TrueType, @code{-otf} pour les polices OpenType et @code{-type1} pour les
polices Type 1 de PostScript.


@node Style de code
@section Style de code

En général notre code suit le Standard de Code GNU (@pxref{Top,,, standards,
GNU Coding Standards}).  Cependant, il ne parle pas beaucoup de Scheme, donc
voici quelques règles supplémentaires.

@menu
* Paradigme de programmation::  Comment composer vos éléments.
* Modules::                  Où stocker votre code ?
* Types de données et reconnaissance de motif::  Implémenter des 
                                                    structures de données.
* Formatage du code::        Conventions d'écriture.
@end menu

@node Paradigme de programmation
@subsection Paradigme de programmation

Le code Scheme dans Guix est écrit dans un style purement fonctionnel.  Le
code qui s'occupe des entrées-sorties est une exception ainsi que les
procédures qui implémentent des concepts bas-niveau comme la procédure
@code{memoize}.

@node Modules
@subsection Modules

Les modules Guile qui sont sensés être utilisés du côté de la construction
doivent se trouver dans l'espace de nom @code{(guix build @dots{})}.  Ils ne
doivent pas se référer à d'autres modules Guix ou GNU@.  Cependant il est
correct pour un module « côté hôte » de dépendre d'un module coté
construction.

Les modules qui s'occupent du système GNU général devraient se trouver dans
l'espace de nom @code{(gnu @dots{})} plutôt que @code{(guix @dots{})}.

@node Types de données et reconnaissance de motif
@subsection Types de données et reconnaissance de motif

La tendance en Lisp classique est d'utiliser des listes pour tout
représenter et de naviguer dedans « à la main ( avec @code{car}, @code{cdr},
@code{cadr} et compagnie.  Il y a plusieurs problèmes avec ce style,
notamment le fait qu'il soit dur à lire, source d'erreur et un obstacle aux
rapports d'erreur bien typés.

Le code de Guix devrait définir des types de données appropriées (par
exemple, avec @code{define-record-type*}) plutôt que d'abuser des listes.
En plus, il devrait utiliser la recherche de motifs, via le module Guile
@code{(ice-9 match)}, surtout pour rechercher dans des listes
(@pxref{Pattern Matching,,, guile, GNU Guile Reference Manual}).

@node Formatage du code
@subsection Formatage du code

@cindex formater le code
@cindex style de code
Lorsque nous écrivons du code Scheme, nous suivons la sagesse commune aux
programmeurs Scheme.  En général, nous suivons les
@url{https://mumble.net/~campbell/scheme/style.txt, règles de style de
Riastradh}.  Ce document décrit aussi les conventions utilisées dans le code
de Guile.  Il est bien pensé et bien écrit, alors n'hésitez pas à le lire.

Certaines formes spéciales introduites dans Guix comme la macro
@code{substitute*} ont des règles d'indentation spécifiques.  Elles sont
définies dans le fichier @file{.dir-locals.el} qu'Emacs utilise
automatiquement.  Remarquez aussi qu'Emacs-Guix fournit le mode
@code{guix-devel-mode} qui indente et colore le code Guix correctement
(@pxref{Développement,,, emacs-guix, The Emacs-Guix Reference Manual}).

@cindex indentation, du code
@cindex formatage, du code
Si vous n'utilisez pas Emacs, assurez-vous que votre éditeur connaisse ces
règles.  Pour indenter automatiquement une définition de paquet, vous pouvez
aussi lancer :

@example
./etc/indent-code.el gnu/packages/@var{file}.scm @var{package}
@end example

@noindent
Cela indente automatiquement la définition de @var{package} dans
@file{gnu/packages/@var{file}.scm} en lançant Emacs en mode commande.  Pour
indenter un fichier complet, n'indiquez pas de second argument :

@example
./etc/indent-code.el gnu/services/@var{file}.scm
@end example

@cindex Vim, édition de code Scheme
Si vous éditez du code avec Vim, nous recommandons de lancer @code{:set
autoindent} pour que votre code soit automatiquement indenté au moment où
vous l'entrez.  En plus,
@uref{https://www.vim.org/scripts/script.php?script_id=3998,
@code{paredit.vim}} peut vous aider à gérer toutes ces parenthèses.

Nous demandons que toutes les procédure de premier niveau contiennent une
chaîne de documentation.  Ce prérequis peut être relâché pour les procédures
privées simples dans l'espace de nom @code{(guix build @dots{})} cependant.

Les procédures ne devraient pas avoir plus de quatre paramètres
positionnés. Utilisez des paramètres nommés pour les procédures qui prennent
plus de quatre paramètres.


@node Envoyer des correctifs
@section Envoyer des correctifs

Le développement se fait avec le système de contrôle de version Git.  Ainsi,
l'accès au dépôt n'est pas strictement nécessaire.  Nous accueillons les
contributions sous forme de correctifs produits par @code{git format-patch}
envoyés sur la liste de diffusion @email{guix-patches@@gnu.org}.  Si vous
êtes un contributeur de Guix confirmé, vous pouvez aussi regarder la section
sur les accès en commit (@pxref{Accès en commit}).

Cette liste de diffusion est gérée par une instance Debbugs, qui nous permet
de suivre les soumissions.  Chaque message envoyé à cette liste se voit
attribuer un nouveau numéro de suivi ; les gens peuvent ensuite répondre à
cette soumission en envoyant un courriel à
@code{@var{NNN}@@debbugs.gnu.org}, où @var{NNN} est le numéro de suivi
(@pxref{Envoyer une série de correctifs}).

Veuillez écrire les messages de commit dans le format ChangeLog
(@pxref{Change Logs,,, standards, GNU Coding Standards}) ; vous pouvez
regarder l'historique des commits pour trouver des exemples.

Avant de soumettre un correctif qui ajoute ou modifie la définition d'un
paquet, veuillez vérifier cette check-list :

@enumerate
@item
Si les auteurs ou autrices du paquet logiciel fournissent une signature
cryptographique pour l'archive, faites un effort pour vérifier
l'authenticité de l'archive.  Pour un fichier de signature GPG détaché, cela
se fait avec la commande @code{gpg --verify}.

@item
Prenez un peu de temps pour fournir un synopsis et une description adéquats
pour le paquet.  Voir @xref{Synopsis et descriptions} pour quelques lignes
directrices.

@item
Lancez @code{guix lint @var{paquet}}, où @var{paquet} est le nom du nouveau
paquet ou du paquet modifié, et corrigez les erreurs qu'il rapporte
(@pxref{Invoquer guix lint}).

@item
Assurez-vous que le paquet se construise sur votre plate-forme avec
@code{guix build @var{paquet}}.

@item
Nous vous recommandons aussi d'essayer de construire le paquet sur les
autres plate-formes prises en charge.  Comme vous n'avez pas forcément accès
aux plate-formes matérielles, nous vous recommandons d'utiliser le
@code{qemu-binfmt-service-type} pour les émuler.  Pour cela, ajoutez le
service suivant à la liste des services dans votre configuration de système
d'exploitation :

@lisp
(service qemu-binfmt-service-type
 (qemu-binfmt-configuration
   (platforms (lookup-qemu-platforms "arm" "aarch64"))
@end lisp

Puis reconfigurez votre système.

Vous pourrez ensuite construire les paquets pour différentes plate-formes en
spécifiant l'option @code{--system}.  Par exemple pour construire le paquet
« hello » pour les architectures armhf, aarch64 ou mips64, vous devrez
lancer les commandes suivantes, respectivement :
@example
guix build --system=armhf-linux --rounds=2 hello
guix build --system=aarch64-linux --rounds=2 hello
@end example

@item
@cindex construction groupée
Assurez-vous que le paquet n'utilise pas de copie groupée d'un logiciel déjà
disponible dans un paquet séparé.

Parfois, les paquets incluent des copie du code source de leurs dépendances
pour le confort des utilisateur·rice·s.  Cependant, en tant que
distribution, nous voulons nous assurer que ces paquets utilisent bien les
copient que nous avons déjà dans la distribution si elles existent.  Cela
améliore l'utilisation des ressources (la dépendance n'est construite et
stockée qu'une seule fois) et permet à la distribution de faire des
changements transversaux comme appliquer des correctifs de sécurité pour un
paquet donné depuis un unique emplacement et qu'ils affectent tout le
système, ce qu'empêchent les copies groupées.

@item
Regardez le profil rapporté par @command{guix size} (@pxref{Invoquer guix size}).  Cela vous permettra de remarquer des références à d'autres paquets
qui ont été retenus sans que vous vous y attendiez.  Il peut aussi aider à
déterminer s'il faut découper le paquet (@pxref{Des paquets avec plusieurs
résultats}) et quelles dépendances facultatives utiliser.  En particulier,
évitez d'ajouter @code{texlive} en dépendance : à cause de sa taille
extrême, utilisez @code{texlive-tiny} ou @code{texlive-union} à la place.

@item
Pour les changements important, vérifiez que les paquets qui en dépendent
(s'ils existent) ne sont pas affectés par le changement ; @code{guix refresh
--list-dependant @var{paquet}} vous aidera (@pxref{Invoquer guix refresh}).

@c See <https://lists.gnu.org/archive/html/guix-devel/2016-10/msg00933.html>.
@cindex stratégie de branche
@cindex stratégie de planification des reconstructions
Suivant le nombre de paquets dépendants et donc le nombre de reconstruction
induites, les commits vont vers des branches différentes, suivant ces
principes :

@table @asis
@item 300 paquets dépendants ou moins
branche @code{master} (changements non-disruptifs).

@item entre 300 et 1 800 paquets dépendants
branche @code{staging} (changements non-disruptifs).  Cette branche devrait
être fusionnées dans @code{master} toutes les 6 semaines.  Les changements
par thèmes (par exemple une mise à jour de la pile GNOME) peuvent aller dans
une branche spécifique (disons, @code{gnome-updates}).

@item plus de 1 800 paquets dépendants
la branche @code{core-updates} (peut inclure des changements majeurs et
potentiellement disruptifs).  Cette branche devrait être fusionnée dans
@code{master} tous les 6 mois environ.
@end table

Toutes ces branches sont @uref{@value{SUBSTITUTE-URL}, gérées par notre
ferme de construction} et fusionnées dans @code{master} une fois que tout a
été construit correctement.  Celà nous permet de corriger des problèmes
avant qu'ils n'atteignent les utilisateur·rice·s et réduit la fenêtre
pendant laquelle les binaires pré-construits ne sont pas disponibles.

@c TODO: It would be good with badges on the website that tracks these
@c branches.  Or maybe even a status page.
Lorsqu'on décide de commencer à construire la branche @code{staging} ou
@code{core-updates}, on les fork et on les renomme avec le suffixe
@code{-frozen}, et à partir de ce moment, seuls les corrections de bogues
sont poussées sur les branches gelées. Les branches @code{core-updates} et
@code{staging} restent ouvertes et acceptent des correctifs pour le prochain
cycle. Demandez sur la liste de diffusion ou sur IRC si vous ne savez pas où
envoyer un correctif.

@item
@cindex déterminisme, du processus de construction
@cindex construction reproductibles, vérification
Vérifiez si le processus de construction du paquet est déterministe.  Cela
signifie typiquement vérifier qu'une construction indépendante du paquet
renvoie exactement le même résultat que vous avez obtenu, bit à bit.

Une manière simple de le faire est de reconstruire le paquet plusieurs fois
à la suite sur votre machine (@pxref{Invoquer guix build}) :

@example
guix build --rounds=2 mon-paquet
@end example

Cela est suffisant pour trouver une classe de non-déterminisme commune,
comme l'horodatage ou des sorties générées aléatoirement dans le résultat de
la construction.

Une autre option consiste à utiliser @command{guix challenge}
(@pxref{Invoquer guix challenge}).  Vous pouvez lancer la commande une fois
que les paquets ont été committés et construits par
@code{@value{SUBSTITUTE-SERVER}} pour vérifier s'il obtient le même résultat
que vous.  Mieux encore : trouvez une autre machine qui peut le construire
et lancez @command{guix publish}.  Puisque la machine distante est sûrement
différente de la vôtre, cela peut trouver des problèmes de non-déterminisme
liés au matériel — par exemple utiliser une extension du jeu d'instruction —
ou du noyau du système d'exploitation — par exemple se reposer sur
@code{uname} ou les fichiers de @file{/proc}.

@item
Lorsque vous écrivez de la documentation, utilisez une formulation au genre
neutre lorsque vous vous référez à des personnes, comme le
@uref{https://fr.wikipedia.org/wiki/They_singulier, ``they''@comma{}
``their''@comma{} ``them'' singulier} (en anglais).

@item
Vérifiez que votre correctif contienne seulement un ensemble de changements
liés.  Grouper des changements non liés ensemble rend la revue plus
difficile et plus lente.

Ajouter plusieurs paquet ou une mise à jour d'un paquet avec des corrections
dans ce paquet sont des exemples de changements sans rapport.

@item
Suivez nos règles de formatage de code, éventuellement en lançant le script
@command{et/indent-code.el} pour le faire automatiquement (@pxref{Formatage
du code}).

@item
Si possible, utilisez des miroirs dans l'URL des sources (@pxref{Invoquer guix download}).  Utilisez des URL stable, pas des URL générées.  Par
exemple, les archives GitHub ne sont pas nécessairement identiques d'une
génération à la suivante, donc il vaut mieux dans ce cas cloner le dépôt.
N'utilisez pas le champ @command{name} dans l'URL : ce n'est pas très utile
et si le nom change, l'URL sera probablement erronée.

@item
Vérifiez si Guix compile (@pxref{Construire depuis Git}) et corrigez les
avertissements, surtout ceux à propos de symboles manquants.

@item
Assurez-vous que vos changements ne cassent pas Guix et simulez un
@code{guix pull} avec :
@example
guix pull --url=/path/to/your/checkout --profile=/tmp/guix.master
@end example

@end enumerate

Lorsque vous postez un patch sur la liste de diffusion, utilisez
@samp{[PATCH] @dots{}} comme sujet, si votre patch doit être appliqué sur
une branche autre que @code{master}, disons @code{core-updates}, spécifiez
le dans le sujet comme @samp{[PATCH core-updates] @dots{}}. Vous pouvez
utiliser votre client de messagerie ou la commande @command{git send-email}
(@pxref{Envoyer une série de correctifs}). Nous préférons recevoir les correctifs
dans des messages en texte clair, soit en ligne, soit sous forme de pièces
jointes MIME.  Il vous est conseillé de faire attention si votre client de
messagerie modifie quoi que ce soit, comme des sauts de ligne ou des
indentations, qui pourraient potentiellement casser les correctifs.

Lorsqu'un bogue est résolu, veuillez fermer le fil en envoyant un courriel à
@email{@var{NNN}-done@@debbugs.gnu.org}.

@unnumberedsubsec Envoyer une série de correctifs
@anchor{Envoyer une série de correctifs}
@cindex série de correctifs
@cindex @code{git send-email}
@cindex @code{git-send-email}

@c Debbugs bug: https://debbugs.gnu.org/db/15/15361.html
Lorsque vous envoyez une série de correctifs (p.@: ex.@: avec @code{git
send-email}), envoyez d'abord une premier message à
@email{guix-patches@@gnu.org} puis envoyez le reste des correctifs à
@email{@var{NNN}@@debbugs.gnu.org} pour vous assurer qu'ils seront groupés
ensemble.  Voyez @uref{https://debbugs.gnu.org/Advanced.html, la
documentation de Debbugs} pour plus d'informations.  Vous pouvez installer
@command{git send-email} avec @command{guix install git:send-email}.

@node Suivi des bogues et des correctifs
@section Suivi des bogues et des correctifs

@cindex rapports de bogue, suivi
@cindex soumission de correctifs, suivi
@cindex suivi de tickets
@cindex Debbugs, système de suivi de tickets
Les rapports de bogue et les correctifs soumis sont actuellement suivis par
l'instance Debbugs @uref{https://bugs.gnu.org}.  Les rapports de bogue sont
rempli pour le « paquet » @code{guix} (dans le vocabulaire de Debbugs), en
envoyant un courriel à @email{bug-guix@@gnu.org}, tandis que les correctifs
sont soumis pour le paquet @code{guix-patches} en envoyant un courriel à
@email{guix-patches@@gnu.org} (@pxref{Envoyer des correctifs}).

Une interface web (en fait @emph{deux} interfaces web !) sont disponibles
pour naviguer dans les tickets :

@itemize
@item
@url{https://issues.guix.gnu.org} fournit une interface
agréable@footnote{L'interface web à @url{https://issues.guix.gnu.org} est
alimentée par Mumi, un logiciel très cool écrit en Guile, votre aide est la
bienvenue ! Voir
@url{https://git.elephly.net/gitweb.cgi?p=software/mumi.git}.} pour
consulter les rapports de bogues et les correctifs, et pour participer aux
discussions ;
@item
@url{https://bugs.gnu.org/guix} liste les rapports de bogues ;
@item
@url{https://bugs.gnu.org/guix-patches} liste les tickets soumis.
@end itemize

Pour consulter les discussions relatives au numéro d'édition @var{n},
rendez-vous sur @indicateurl{https://issues.guix.gnu.org/@var{n}} ou
@indicateurl{https://bugs.gnu.org/@var{n}}.

Si vous utilisez Emacs, vous pourriez trouver plus confortable d'interagir
avec les tickets en utilisant @file{debbugs.el}, que vous pouvez installer
avec :

@example
guix install emacs-debbugs
@end example

Par exemple, pour lister tous les tickets ouverts sur @code{guix-patches},
tapez :

@example
@kbd{C-u} @kbd{M-x} debbugs-gnu @kbd{RET} @kbd{RET} guix-patches @kbd{RET} n y
@end example

@xref{Top,,, debbugs-ug, Debbugs User Guide}, pour plus d'info sur cet outil
pratique !

@node Accès en commit
@section Accès en commit

@cindex accès en commit, pour les développeurs
Pour les contributeurs réguliers, il est pratique d'avoir accès en écriture
au dépôt.  Lorsque vous l'estimez nécessaire, pensez à candidater à l'accès
en commit en suivant les étapes suivantes :

@enumerate
@item
Trouvez trois commiteurs qui soutiendront votre candidature.  Vous pouvez
trouver la liste des commiteurs sur
@url{https://savannah.gnu.org/project/memberlist.php?group=guix}.  Chacun
d'entre eux devra envoyer une déclaration à
@email{guix-maintainers@@gnu.org} (un alias privé pour le collectif des
mainteneurs), signé de leur clef OpenPGP.

Les commiteurs devront avoir eu des interactions avec vous en tant que
contributeur et pouvoir juger si vous êtes suffisament familier avec les
pratiques du projet.  Ce n'est @emph{pas} un jugement sur la valeur de votre
travail, donc vous devriez plutôt interpréter un refus comme un « essayons
un peu plus tard ».

@item
Envoyez un message à @email{guix-maintainers@@gnu.org} déclarant votre
intention, listant les trois commiteurs qui supportent votre candidature,
signez-le avec la clef OpenPGP que vous utiliserez pour signer vos commits
et donnez son empreinte (voir plus bas).  Voir
@uref{https://emailselfdefense.fsf.org/fr/}, pour une introduction à la
cryptopgraphie à clef publique avec GnuPG.

@c See <https://sha-mbles.github.io/>.
Configurer GnuPG de manière à ce qu'il n'utilise jamais l'algorithme de
hachage SHA1 pour les signatures numériques, dont on sait qu'il est
dangereux depuis 2019, par exemple en ajoutant la ligne suivante à
@file{~/.gnupg/gpg.conf} (@pxref{GPG Esoteric Options, , , gnupg, The GNU
Privacy Guard Manual}) :

@example
digest-algo sha512
@end example

@item
Les mainteneurs ont le dernier mot sur la décision de vous donner accès et
suivent généralement l'avis de vos référents.

@item
@cindex OpenPGP, commits signés
Si vous obtenez l'accès, envoyez un message à @email{guix-devel@@gnu.org}
pour le faire savoir, en signant de nouveau avec le clef OpenPGP que vous
utiliserez pour signer les commits (faites-le avant votre premier commit).
De cette manière, tout le monde peut s'en rendre compte et s'assurer que
c'est bien vous qui contrôlez cette clef OpenPGP.

@quotation Important
Avant d'envoyer pour la première fois, les mainteneurs doivent :

@enumerate
@item
ajoutez votre clé OpenPGP à la branche @code{keyring} ;
@item
ajoutez votre empreinte OpenPGP au fichier @file{.guix-authorizations} de la
(des) branche(s) sur laquelle (lesquelles) vous vous engagez.
@end enumerate
@end quotation

@item
Assurez-vous de lire le reste de cette section et… profitez !
@end enumerate

@quotation Remarque
Les mainteneurs sont ravis de donnéer l'accès en commit aux personnes qui
ont contribués depuis un certain temps et ont un bon bilan — ne soyez pas
timide et ne sous-estimez pas votre travail !

Cependant, remarquez que le projet travail sur un système de revu de
correctifs et de fusion plus automatisé, qui, en conséquence, pourra nous
faire réduire le nombre de personne ayant accès en commit au dépôt
principal.  Restez à l'écoute !
@end quotation

Si vous avez accès en commit, assurez-vous de respecter la politique
ci-dessous (les discussions à propos de cette politique peuvent avoir lieu
sur @email{guix-devel@@gnu.org}).

Les correctifs non triviaux doivent toujours être postés sur
@email{guix-patches@@gnu.org} (les correctifs triviaux consistent en des
correctifs de coquilles, etc).  Cette liste de diffusion rempli la base de
données de correctifs (@pxref{Suivi des bogues et des correctifs}).

Pour les correctifs qui ne font qu'ajouter un nouveau paquet, et un paquet
simple, commiter directement est accepté si vous êtes en confiance (ce qui
signifie que vous avez réussi à le construire dans un environnement chroot
et avez fait un audit suffisant des copyrights et de la licence).  Pareil
pour les mises à jour de paquets, sauf pour les mises à jour qui
occasionnent beaucoup de reconstruction (par exemple mettre à jour GnuTLS ou
GLib).  Nous avons une liste de diffusion pour les notifications de commit
(@email{guix-commits@@gnu.org}), pour que les gens puissent s'en rendre
compte.  Avant de pousser vos changements, assurez-vous d'avoir lancé
@code{git pull --rebase}.

Tous les commits poussés sur le dépôt central sur Savannah doivent être
signés avec une clef OpenPGP et la clef publique doit être chargée sur votre
compte utilisateur dans Savannah et les serveurs de clef publique, comme
@code{keys.opengpg.org}.  Pour configurer Git pour signer automatiquement
vos commits, lancez :

@example
git config commit.gpgsign true
git config user.signingkey CABBA6EA1DC0FF33
@end example

Vous pouvez éviter de pousser accidentellement des commits non signés vers
Savannah et utilisant le crochet Git de pré-envoi situé dans
@file{etc/git/pre-push} :

@example
cp etc/git/pre-push .git/hooks/pre-push
@end example

Lorsque vous poussez un commit pour le compte de quelqu'un d'autre, ajoutez
une ligne @code{Signed-off-by} à la fin du message de commit — p.@: ex.@:
avec @command{git am --signoff}.  Cela amélior le suivi que qui fait quoi.

Quand vous ajoutez de nouvelles entrées au canal (@pxref{Canaux, Writing
Channel News}), assurez-vous qu'elles sont bien formées en exécutant la
commande suivante juste avant d'envoyer :

@example
make check-channel-news
@end example

Pour tout autre chose, envoyez un correctif à @email{guix-patches@@gnu.org}
et laissez un peu de temps pour la revue, sans rien commiter
(@pxref{Envoyer des correctifs}).  Si vous ne recevez pas de réponse dans les
deux semaines et que vous avez confiance, vous pouvez commiter.

La dernière partie est sujète à ajustement, pour permettre à certains de
commiter directement des changements non controversés sur des parties qui
leurs sont familières.

Pour réduire la probabilité de faire une erreur, celles et ceux qui peuvent
commiter seront retiré·e·s du projet Guix sur Savannah et leur clé supprimée
de @file{.guix-authorizations} après 12 mois d'inactivité ; ils et elles
pourront retrouver leur accès en envoyant un courriel aux mainteneurs, sans
avoir à passer par le processus de cooptation.

Une dernière chose : le projet continue à avancer non seulement parce que
les commiteurs poussent leurs propres changements, mais aussi parce qu'ils
offrent de leur temps pour @emph{revoir} et pousser les changements des
autres personnes.  En tant que commiteur, vous pouvez utiliser votre
expertise et vos droits en commit pour aider d'autres contributeaurs aussi !

@node Mettre à jour Guix
@section Mettre à jour Guix

@cindex update-guix-package, mise à jour du paquet guix
Il est quelquefois souhaitable de mettre à jour le paquet @code{guix}
lui-même (le paquet défini dans @code{(gnu packages package-management)}),
par exemple pour rendre de nouvelles caractéristiques disponibles à
l'utilisation par le type de service @code{guix-service-type}. Afin de
simplifier cette tâche, la commande suivante peut être utilisée :

@example
make update-guix-package
@end example

Le make target @code{update-guix-package} utilisera le dernier @emph{commit}
connu correspondant à @code{HEAD} dans votre checkout Guix, calculera le
hash des sources Guix correspondant à ce commit et mettra à jour la
définition des paquets @code{commit}, @code{revision} et le hash du paquet
@code{guix}.

Pour avoir la certitude que les hash du paquet @code{guix} mis à jour sont
corrects et qu'il peut être construit avec succès, la commande suivante peut
être lancée depuis le répertoire de votre checkout Guix :

@example
./pre-inst-env guix build guix
@end example

Pour éviter de mettre à jour accidentellement le paquet @code{guix} en un
commit auquel les autres ne peuvent pas se référer, on vérifie que le commit
utilisé a déjà été placé dans le dépôt git de Guix hébergé par Savannah.

Cette vérification peut être désactivée, @emph{à vos risques et périls}, en
passant la variable d'environnement
@code{GUIX_ALLOW_ME_TO_USE_PRIVATE_COMMIT}.  Lorsque cette variable est
initialisée, les source du paquet mis à jour est aussi ajouté au dépôt.
Cela est utilisé dans le processus de publication de Guix.
