Aller au contenu

Guide de contribution#

Processus (workflow)#

1. Cloner le dépôt central localement#

1
git clone https://github.com/geotribu/website.git

2. Créer ou utiliser une branche git locale#

Pour afficher les différentes branches actives afin de sélectionner celle souhaitée, il suffit de lister les branches distantes pour savoir si une revue de presse a déjà été créée :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
# liste les branches débutant par 'rdp'
git branch --list 'rdp*'

  rdp/2020-04-03

# liste toutes les branches centralisées
git branch -r

  origin/HEAD -> origin/master
  origin/ci-cd
  origin/gh-pages
  origin/master
  origin/material-5
  origin/pelican
  origin/rdp/2020-04-03
  origin/tutorials
  origin/tutos
  origin/vuepress

Basculer ensuite sur la branche qui va bien :

  • soit en créant une branche locale rdp/2020-04-03 :

    1
    2
    git checkout -b rdp/2020-04-03
    Switched to a new branch 'rdp/2020-04-03'
    
  • soit en utilisant la branche rdp/2020-04-03 déjà existante

    1
    2
    git checkout rdp/2020-04-03
    Switched to a new branch 'rdp/2020-04-03'
    

3. Créer/modifier localement du contenu en markdown#

Le bon moment de se rappeler comment écrire du bon markdown 😉 !

4. Enregistrer sa modification#

Ajouter un message bref qui décrivant :

1
git commit -am "Ajout news sur la carte de la semaine"

5. Pousser son contenu avec Git vers le dépôt central#

ou vers un dépôt de son compte si on n'a pas les droits

  • si c'est une nouvelle branche

    1
    git push -u origin "rdp/2020-04-03"
    
  • Ou, si c'est une branche déjà existante

    1
    git push
    

6. Proposer la publication sur le site#

Une fois le contenu prêt pour être publié, créer une Pull Request de sa branche vers la branche master du dépôt central

Créer la pull request

Et voilà ! Dès qu'elle sera validée, la correction sera automatiquement publiée 😄.

Warning

Avant d'ajouter du contenu sur une branche déjà existante, bien penser à récupérer les changements faits par les autres contributeurs avant, en faisant :

1
git pull

Modifier un contenu#

Texte#

Voir le guide dédié.

Ajouter une image#

Voir le guide dédié.

Insérer un tweet#

Voir le guide dédié.

Insérer une vidéo#

Voir le guide dédié.

Utiliser un emoji#

Voir le guide dédié.

Créer des diagrammes UML#

Voir le guide dédié.

Signer ses contributions#

Voir le guide dédié.


Créer une revue de presse#

Créer un fichier dans content\rdp\AAAA en respectant le nommage suivant : rdp_AAAA-MM-JJ.md. Exemple : content\rdp\2020\rdp_2020-06-12.md pour la revue de presse du 12 juin 2020.

Ajouter une news#

Un modèle de news est disponible ici :


Dernière mise à jour: 13 octobre 2020
Contributions à cette page : Julien Moura (89.1%), Aurélien Chaumet (0.64%), pvernier (10.26%)

Commentaires