Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 2.86 KB

Introduction

Merci pour de prendre le temps de contribuer à ce projet communautaire pour promouvoir les sciences des surfaces planétaires à l'échelle de la communauté française. Afin de garantir une certaine homogénéité dans la rédaction de ce guide, merci de suivre les recommandations suivantes.

Format et style

Les articles de ce guide sont rédigés principalement en français en suivant une syntaxe de type markdown (.md) et regroupé dans le dossier docs/. Si vous n'êtes pas familier de ce language, vous pouvez consulter ces quelques exemples pour débuter facilement. Le markdown est le language natif de Github pour la soumission de modification depuis leur interface web. N'hésitez pas à utiliser le bouton preview pour visualiser vos résultats.

Si le contenu de votre article s'y porte, vous pouvez le rédiger directement en jupyter-notebooks (.ipynb).

L'ensemble des articles est reformaté grace à Jupyter-Book et Github pour être afficher sur la page web du pole des surfaces planétaires.

Soumettre un changement, proposer une modification ou un ajout

  1. Faite un fork de ce dépôt pour l'ajouter à votre espace Github en cliquant ici.
  2. Vous pouvez ajoutez un (ou plusieurs) article directement depuis Github ou en copiant le projet localement (cf. section ci-dessous).
  3. Une fois rédigé, pensez à ajouter votre article dans la table des manières (docs/_toc.yml) et si c'est votre première contribution, merci de rajouter votre nom et affiliation dans la liste le fichier AUTHORS.md.
  4. Soumettez une Pull Request avec vos ajouts sur le projet.
  5. Les modifications seront validées manuellement par l'un des membres du pole.
  6. Le guide en ligne sera mis à jour automatiquement avec votre nouvel article 🚀

Modifier ce guide localement

Pour modifier le guide localement, commencez par récupérer une copie du projet (après l'avoir forké):

git clone https://github.com/<GH_USERNAME>/pole-surfaces-planetaires.github.io
cd pole-surfaces-planetaires.github.io

Faites vos modifications dans le dossier docs/.

Si vous voulez visualiser le rendu de votre article avant de le soumettre, vous devez installer les dépendances du projet:

pip install -r requirements.txt

Puis exécuter la commande suivante pour compiler votre article:

jupyter-book build docs/

Le résultat est disponible dans le dossier _build/html/ et peut être visualiser dans votre navigateur web.