Formation C 17
GitHub Basculer le mode Sombre/Clair/Auto Basculer le mode Sombre/Clair/Auto Basculer le mode Sombre/Clair/Auto retour à la page d'accueil

Comment contribuer ?

Table des matières

Avant-propos

Tout d’abord, merci de bien vouloir contribuer et d’aider les Bubus à enrichir ce wiki ! Si vous êtes tombé sur ce fichier par erreur, alors probablement vous venez d’ici.

La lecture de cette section et de celle-là sont obligatoire avant de pouvoir commencer à contribuer.

Promis, on démarre bientôt

Avant de commencer, il faut que vous ayez lu la section spécifiant les règles d’édition et que vous soyez au point avec les outils suivant :

  • le langage Markdown qui est le cœur de rendu des pages présente sur ce wiki,
  • Git qui est le gestionnaire de version utilisé (vous pouvez trouver différentes resources à propos de son utilisation sur ce wiki),
  • l’instance GitLab de l’école sur lequel se trouve se projet,
  • le langage YAML pour les front matter,

les outils suivants sont un peu en bonus

  • Hugo qui est le logiciel permettant de générer le site statique (pas obligatoire si vous faites seulement une modification),
  • Geekdocs (pour la configuration du thème utilisé),
  • quelques bases en HTML et CSS (uniquement si vous voulez faire des modifications un peu avancées),
  • quelques bases en JavaScript (utile uniquement dans de très très rares cas),
  • le langage TOML pour les autres fichiers de configuration (ce point n’est pas primordial dans la grande majorité des cas).

Pourquoi ce fichier ?

Ce document vise à établir des règles d’éditions que les auteurs d’articles sont fortement invités à suivre. Il a pour but d’avoir un Wiki homogène que ce soit dans le style et la forme (en particulier quant au norme typographique) afin d’avoir une lecture plus agréable (et parce qu’au moins un des Bubus est un peu maniaque…).

Cependant, même si ce texte vise à faire autorité, il n’est pas immuable dans le temps et est amené très probablement à changer (potentiellement en profondeur). Je Nous ne somme pas des tyrans.

Dura lex, sed lex (mais pas tellement…)

Si vous trouvez un des points aberrant et inutile, vous pouvez faire une demande de changement en utilisant les GitHub issues.