Contribuer au Livret

Toutes les propositions d'amélioration du Livret sont les bienvenues. Toutefois, afin de faciliter le travail de chacun, voici quelques petites règles et conseils qu'il est bon de suivre.

La méthode la plus simple pour participer est d'envoyer vos remarques, suggestions et idées sur la liste de diffusion du Livret du Libre. Nous pourrons alors discuter des améliorations et modifications à apporter au Livret du Libre avec vous.

Si vous êtes familier de Subversion ou des outils permettant de produire un patch, voici quelques recommandations utiles. Toutefois, il n'est pas nécessaire de connaître tous ces aspects techniques pour participer au Livret: un courrier électronique suffit.

• Le format préféré pour les propositions de changements est un patch généré avec diff -Naur repertoire-originel repertoire-avec-vos-changements ou simplement avec svn diff si vous êtes partis de la version Subversion.
• Si vous proposez de nombreux changements, séparez les selon leur "type" (orthographe, formulations, changements plus profonds) et envoyez les dans des mails différents, afin de provoquer des discussions en parallèle sur les différentes propositions.
• Tentez de garder votre patch le plus petit possible :
  • Ne reformatez pas le texte que vous modifiez, afin que seules les lignes vraiment modifiées apparaissent comme tel dans le patch.
  • Relisez le patch avant de l'envoyer, afin de vérifier qu'il n'inclut pas de changements non souhaités.
• Si vous proposez une modification qui est à effectuer à différents endroits du document, ne préparez pas de patch complet avant d'être sûr qu'elle sera acceptée (demandez nous avant sur la mailing list).
• Expliquez vos changements (justifiez les). Si ce sont des changements mineurs, dites le. Pareil si ce sont des changements dont vous n'êtes pas sûr.
• Lorsque vous soumettez un patch sujet à discussion, incluez-le directement dans le mail (ne le mettez pas en pièce jointe). Cela permet aux autres d'y répondre plus facilement.
• Si vous modifiez la mise en page, vérifiez que vous ne la cassez pas pour la version A5 10pt, A5 11pt, etc ... Il n'y a pas que la version A4 à vérifier !

Enfin, lorsque vous contribuez au Livret, gardez en tête que, pour un document texte de ce type, il n'est souvent pas facile de savoir si une solution est meilleure qu'une autre. Soyez diplomate et compréhensif si nous refusons certaines de vos propositions. Évitez aussi de proposer des modifications dont l'intérêt n'est pas tout à fait évident (par exemple, reformulations qui n'apportent rien à la compréhension, au style, ...)