Les bonnes pratiques du Forum Francophone

:fr: :warning: QUELQUES RÈGLES SIMPLES À LIRE IMPÉRATIVEMENT AVANT DE POSTER :warning:

Elles faciliteront la vie de tous et contribueront à rendre votre expérience la plus enrichissante possible.

Bienvenue !!!

Vous rejoignez une communauté : nous incitons très fortement les nouveaux arrivants sur la partie francophone à rédiger dans ce fil de discussion une rapide présentation personnelle.

Aidez nous à vous aider : les réponses qui sont faites sur le forum francophone arduino sont majoritairement rédigées par des bénévoles passionnés et dans un but d'entraide bienveillante. La mise en œuvre des solutions proposées se fait sous votre responsabilité pleine et entière. Nous faisons de notre mieux pour vous aider, et si vous suivez ces quelques règles cela ira plus vite.

Comment bien poster

  • Poster dans le bon sous forum : Les questions sont à poser dans la partie principale du Forum Francophone, et en aucun cas dans l'une des deux catégories dédiées "Tutoriels et Cours" et "Réalisations/projets Finis"
  • Utilisez l'outil de recherche avant de créer un nouveau sujet ! Une fois dans la fenêtre de recherche, on peut appliquer des filtres pour restreindre la recherche à certaines parties du forum. Si vraiment vous ne trouvez rien avec la recherche, alors posez votre question.

  • Un problème = un fil de discussion. Ne venez pas vous "greffer/accrocher" à un fil existant si votre problème n'est pas exactement identique.

  • Pas de double post, que ce soit dans un autre sous forum ou une autre langue. Si vous postez sur un autre forum la même question, mentionnez le.

  • Utilisez un titre explicite ! Les sujets ayant pour titre “Help”, “A l'aide”, “Au secours” et assimilés… seront supprimés ou édités. Exposez clairement votre question.

  • utilisez les balises : Prenez le temps de formatter correctement votre post. Les balises de code sont obligatoires pour tout code posté (cf les outils ci dessous).

  • Ne pas poster une image d’un texte : C’est illisible sur smartphone, ça encombre les serveurs, ça pollue plus la planète en augmentant la taille de ce qu’on doit télécharger et donc la facture énergétique de tous les utilisateurs et c’est inutilisable pour faire du copier coller. Obligatoire pour le code ou le résultat du moniteur série (en utilisant la balise de code), c'est toléré si le besoin le justifie parce que le texte n'était pas copiable simplement ou présentait des éléments de mise en forme, image + texte importants à la compréhension).

  • Donnez le maximum d'informations : indiquez bien sûr votre problème, postez le code source avec les balises de code, ajoutez les erreurs affichées par le logiciel (du texte se poste en texte, copier coller, pas de copie d'écran de texte). Décrivez les manipulations déjà effectuées pour débuguer ainsi que toute information pertinente (matériel concerné, OS utilisé, version IDE utilisée, schéma électronique du montage, alimentation, etc). Des liens clickables et des schémas clairs sont appréciés.

  • Soyez patient : ce n'est pas parce qu'une question est posée, qu'une réponse DOIT être donnée. Si votre question ne reçoit pas de réponse immédiate, attendez un peu (48h semble un délai raisonnable) avant de relancer… Il se peut aussi que votre question ne soit pas bien formulée ou alors, et cela arrive, que personne n'a de réponse à vous apporter.

  • Marquez la solution: pour les sujets dont la solution a été trouvée, cochez la case [x] solution en bas de la réponse qui vous a permis de résoudre votre problème. Cela aidera d'autres membres qui rencontrent le même souci.

Ces règles sont là pour assurer le bon fonctionnement du forum ! Merci de les respecter.

Utilisation de quelques outils

Faciliter la lecture (qui peut être sur ordinateur, tablette ou smartphone) de votre prose augmente vos chances d'obtenir une réponse rapide. Prenez donc le temps de formatter correctement votre post.

La balise de code :
image

Si vous utilisez l'IDE Arduino, il peut faire la mise en forme pour vous :

  • Assurez vous d'indenter le code correctement dans l'IDE avant de le copier. Cela se fait en pressant ctrlT sur PC ou command ⌘T sur un Mac.
  • Sélectionnez tout le code, puis dans le menu édition vous choisissez Copier pour le forum. il ne vous reste plus qu'à coller dans votre post (en début de ligne)

Pour poster du code si vous utilisez un autre IDE ou si vous tapez directement votre code:

  • pensez à indenter le code, puis copiez tout le code
  • Dans votre fil de discussion appuyez sur l'icône code de la barre d'outils pour insérer la balise de code
  • Cela rajoutera les trois back-ticks et une zone où coller son code à l'endroit du curseur actuel dans votre post
    image
    vous n'avez plus qu'à taper ou coller votre code dans la zone en enlevant le texte "type or paste code here"

Notez que vous pouvez rajouter une précision sur le type d'élément présenté. pour du C++ (le défaut donc rien à rajouter) on peut mettre cpp après les 3 backticks de début. Pour du texte (par exemple le résultat dans me moniteur série) on mettra text

par exemple si on tape
image

la présentation sera la suivante :

void uneFonction() {}
ceci sera un texte non mis en forme 123

alors que si on n'a pas mis text après les 3 backticks, la règle de C++ va s'appliquer et des couleurs vont être appliquées.

void uneFonction() {}
ceci sera un texte non mis en forme 123

La balise de citation (quote)


pour nous exposer vos erreurs ou reprendre les commentaires précédents.
les quotes de l'intégralité du message qui est juste en dessus sont inutiles et alourdissent la lecture. Le bon usage des quotes est soit de reprendre un point établi précédemment, soit de reprendre une liste de point pour y répondre 1 par 1 (en découpant alors en plusieurs quote). Dans tous les cas il est plus lisible de ne reprendre que le texte sur lequel on répond. Evitez de citer les images (sauf si réellement utile pour justifier sa réponse)


L'outil d'édition (en forme de crayon)
image
➪ A utiliser si vous avez une modification à apporter à un de vos posts (par exemple rajouter les balises de code...). Ne changez rien qui rendrait la suite de la conversation incompréhensible (par exemple n'enlevez pas vos erreurs si elles font partie de la discussion qui suit).



l'équipe de modération du forum
jfs

10 Likes

Et si vous ne l’avez jamais lu, il y a beaucoup à apprendre de ce document

De la bonne manière de poser les questions

4 Likes