Comment rédiger un article ?

De Magazine fedora-fr
Révision de 12 octobre 2015 à 13:16 par CharlesAntoineCouret (discussion | contributions) (Page créée avec « == Prérequis == Pour récupérer les sources du magazine en développement, vous devez utiliser le programme git dans votre émulateur de terminal comme suit : <code>$... »)

(diff) ← Version précédente | Voir la version courante (diff) | Version suivante → (diff)
Aller à : navigation, rechercher

Prérequis

Pour récupérer les sources du magazine en développement, vous devez utiliser le programme git dans votre émulateur de terminal comme suit : $ git clone https://git.fedorahosted.org/git/Muffin.git

Si vous n'avez pas git, vous pouvez l'installer ainsi : # dnf install git

L'écriture des articles se fait à l'aide du formatage Markdown dont vous pouvez lire un tutoriel sur le sujet pour apprendre à vous en servir. N'importe quel éditeur de texte peut manipuler ce type de document.

Pour générer le rendu final, sera sans doute utilisé l'utilitaire poole dont un exemple est disponible. Quand il sera stabilisé, il sera disponible dans l'espace de travail de Muffin.

Notez que le rendu définitif sera réalisé par les responsables de Muffin.


Être à jour

Pour récupérer l'environnement de travail, vous devez avant vous assurer d'avoir effectué ou compris les points précédents.

Une fois cela fait, vous pouvez récupérer les dernières modifications apportées dans Muffin grâce à la commande suivante (tapée dans le répertoire de travail) : $ git pull

Créer une branche personnelle de travail

Avant de commencer, nous vous recommandons de créer une branche de travail ainsi : $ git checkout -b nom_ma_branche

Il est recommandé d'en faire une pour chaque modification importante.


Écriture et soumission d'un article

Comme dit précédemment, votre article devra être rédigé au format markdown en étant situé dans le répertoire articles. Vous pouvez réutiliser les icônes situés dans icons et ajouter des images dont des captures d'écran dans figures.

Quand votre travail est suffisamment avancé et que vous souhaitez le soumettre, vous devrez faire les opérations suivantes dans le répertoire de travail :

$ git pull
$ git add -A
$ git diff > monTravail.diff
$ git commit -m "Résumez vos travaux ici"

La première commande met à jour l'espace de travail, étape nécessaire. La seconde ajoute vos fichiers dans l'arbre de travail, pensez à supprimer les fichiers que vous avez crée temporairement. La troisième génère les différence entre votre travail et le Muffin actuel.

Envoyez ce fichier monTravail.diff et vos images à la liste de diffusion fr-users@lists.fedoraproject.org ; mettez [Muffin] Titre de votre article dans en titre de message.


Modifier le travail soumis

Il est possible que le travail que vous avait soumis comporte trop de fautes ou nécessite d'autres changements. Avant de le valider, vous serez invités à le modifier encore.

Une fois que les remarques ont été prises en compte, refaites les commandes du point précédent et envoyez vos fichiers.

Quand votre modification est acceptée

Quand votre modification sera jugée acceptable, les mainteneurs les mettront à disposition dans l'espace de travail et une mise à jour de votre espace de travail permettra de le récupérer. Pour se faire, procédez ainsi :

$ git branch -d nom_ma_branche
$ git pull

En cas de questions

Si vous avez une question à propos de la méthodologie, un problème lié à ces manipulations, ou tout autre question liée à Muffin, veuillez écrire à la liste de diffusion fr-users@lists.fedoraproject.org

Et vous pouvez recommencer à l'étape Créer une branche personnelle de travail