Présentation
Cette page définit le guide de style pour dtdocs et donne des informations sur la manière de contribuer au projet.
Elle est incluse dans le manuel d’utilisation afin que vous puissiez voir comment la page est rendue ainsi que comment elle est écrite. Rendez vous sur GitHub pour voir la source de cette page.
La structure et le contenu du manuel ont été soigneusement étudiés sur la base des critères suivants :
- Le manuel doit être complet - il doit décrire toutes les fonctionnalités disponibles dans darktable.
- Il doit avoir une structure cohérente et logique ; et chaque élément de fonctionnalité doit apparaître à sa place logique propre dans cette structure.
- Il doit être aussi long que nécessaire mais aussi court que possible – la concision est une nécessité.
- Il doit être factuel.
- La fonctionnalité doit être expliquée une et une seule fois (à l’exception des directives de base sur le flux de travail dans la section d’aperçu).
- Les images ne doivent être incluses que si elle sont indispensable à la compréhension de principes clés. Elles ne doivent pas contenir de texte, sauf si cela est inévitable.
Nous ne sommes en général pas intéressé⋅es par :
- Une restructuration du manuel.
- Un changement de langage de markup.
- Des tutoriels détaillés de flux de travail (par contre, nous sommes intéressé⋅es à les publier sur les blogs de darktable.org ou de pixls.us).
Nous sommes intéressé⋅es par :
- Les corrections orthographiques et syntaxiques.
- La clarification de texte.
- La documentation de nouvelles fonctionnalités
Nous sommes toujours extrêmement intéressés de savoir quelles sont les sections du manuel que vous n’avez pas trouvé intelligibles et pourquoi, afin que nous puissions améliorer cette documentation.
En général, si vous souhaitez apporter un changement majeur, veuillez ouvrir un ticket et en discuter tout d’abord avec les mainteneurs. Ceci afin de vous éviter un travail qui ne serait pas accepté.
🔗modalité
La méthode recommandée consiste à créer une « pull request ». Consultez le [flux de travail]](workflow.md) pour obtenir un guide détaillé étape par étape.
Si vous ne savez pas de quoi il s’agit ou si vous n’êtes pas à l’aise avec cette procédure, n’hésitez pas à proposer des améliorations mineures à la documentation en ouvrant un nouveau ticket sur GitHub.