Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 4.04 KB

CONTRIBUTING.md

File metadata and controls

67 lines (46 loc) · 4.04 KB

Contribuer à Solaires

« On va se faire des tas de nouveaux amis ? »

Idle

Qui peut contribuer ?

Tout le monde peut contribuer. Que ce soit pour proposer de nouvelles choses, effectuer des corrections ou encore d'autres choses auxquelles je n'ai pas pensé.

Évidemment, je (Greewi) reste le gardien du temple et je peux donc refuser certaines modifications, mais vous aurez toujours un retour vous expliquant pourquoi.

Code de conduite

Vous êtes grands (enfin je suppose) et j'attends un minimum de cordialité et de respect de chacun envers chacun. J'apprécierais ne pas avoir à gérer de conflits ou autres tempêtes de caca (j'allais dire un gros mot mais Idle m'a arrêté à temps). Les contrevenants devront voir avec Nevi et son tout dernier joujou made in nevian.

Que puis-je-faire pour contribuer ?

Si vous avez des suggestions, des remarques ou des questions, n'hésitez pas à créer une « Issue » sur GitHub. J'essaierais d'y répondre rapidement.

Si vous souhaitez faire des corrections vous pouvez suivre la procédure suivante :

  • Faites un fork du projet.
  • Clonez votre fork sur votre ordinateur.
  • Faites vos modifications sur une branche dédiée.
  • Commitez vos modifications sur votre fork et faite un push.
  • Faites une pull request.

Essayez tant que possible d'être clair dans le message de commit. En fonction de la nature des modifications, ajoutez au début du titre du commit :

  • :sparkles: pour de nouveaux articles ;
  • ✏️ :pencil2: pour des corrections orthographiques, grammaticales, syntaxiques ou typographiques ;
  • 🎨 :art: lorsque vous effectuez des améliorations de styles ou visuelles.

Si vous souhaitez proposer du nouveau contenu, ouvrez une « Issue » avant de vous mettre au travail pour en discuter. Je serais très triste de voir une pull request avec du contenu qui ne serait pas compatible avec le reste.

Format des textes et conventions

Tous les textes de ce dépôt sont au format Markdown. Toutefois, nous avons choisis quelques conventions propres pour ce projet. Voici les principales règles.

Concernant les textes :

  • **texte** est utilisé pour les emphases (et non pour dire gras !) ;
  • *texte* est utilisé pour les exemples (et non pour dire italique !) ;
  • Les articles ont un et un seul titre de niveau 1 (#) : le titre de l'article ;
  • Les articles n'ont ensuite que des titres de niveau 2 (##) ;
  • Nous n'utilisons pas de titre de niveau 3 ! La seule exception concerne les titres des encarts ;
  • Mettez des espaces insécables (AltGr+shift+espace avec la disposition de clavier fr-oss, le clavier français alternatif de linux, généralement installé par défaut) devant les signes de ponctuations les nécessitants (points d'interrogation, points d'exclamation, points virgules, deux points, etc.) et entre les nombres et leurs unités (ex. 2 mm).

Concernant les tableaux :

  • Les tableaux sont en HTML, sans style ;
  • Pas de code Markdown à l'intérieur d'un tableau ;
  • Seules les balises <table>, <tr>, <td> et <th> sont autorisées ;
  • Utilisez des th pour les cellules d'entêtes, y compris celles de gauche dans les tableaux à deux entrées ;
  • Ne divisez pas une balise <td> sur plusieurs lignes.

Concernant les encarts :

  • Les encarts sont définis par des sections dont toutes les lignes commencent par >>  ;
  • Les éventuels titres des encarts doivent être de niveau 3 (###) ;
  • Vous pouvez utiliser les formats Markdown habituels dans les encarts, mais pas de HTML (et donc pas de tableaux).

Dans le doute, inspirez-vous de la syntaxe des articles existants.

Être crédité

C'est très simple : je refuse catégoriquement de ne pas créditer un contributeur.

Aussi, lorsque vous me transmettez une pull request, indiquez-moi sous quel nom vous souhaitez être crédités. Si vous ne le faites pas, je prendrais votre pseudonyme GitHub. Les crédits sont présents dans le README du projet et dans l'article Crédits de l'encyclopédie.

Si je vous ai oublié, contactez-moi, ce n'est certainement pas volontaire.