Comment contribuer ?
Au projet ?
Si vous souhaitez nous aider sur ce projet, n’hésites pas à nous contacter par e-mail :
A cette documentation ?
Si vous souhaitez apporter votre contribution à cette documentation, suivez ce guide pour vous aider à bien commencer et à ajouter vos modifications !
Familiarisez-vous avec le guide de style
Il n’est pas obligatoire de lire le guide de style, mais il est important de s’y référer lors de vos contributions.
Prenez donc le temps de lire le guide une première fois pour vous assurer que la documentation est familière à toute personne qui la consulte.
Créer votre propre copie de la documentation
Commençons par forker et cloner le dépôt de documentation.
Forking
Allez sur cloudducoeur/documentation.
Cliquez sur le bouton Fork en haut à droite pour créer votre propre copie
Cloner le dépôt
Clonez votre fork fraîchement créé.
Cliquez sur l’onglet Code > SSH. Copiez l’adresse du dépôt.
Ouvrez un terminal à l’endroit désiré et clonez avec
git clone <URL copiée>
# exemple : git clone git@github.com:cloudducoeur/documentation.gitDémarrer l’environnement local
Entrez dans le nouveau répertoire créé (par défaut, documentation), et exécutez simplement :
docker compose upCeci téléchargera une image Docker et démarrera le serveur hugo en mode développement.
Vous pouvez consulter la documentation en visitant localhost:1313.
Toute modification de fichier sera rechargée à chaud et rafraîchira la page dans votre navigateur. Pratique !
Créer une nouvelle branche
Créez une branche pour ajouter votre contribution. Elle sera utilisée plus tard pour faire une Pull Request.
git switch -c my-contribQuel type de changement voulez-vous effectuer ?
Commit, push et Pull Request !
Une fois que vous avez fini de faire vos changements, validez-les.
git add <fichier1> <fichier2>
git commit -m « <message pour les changements que j'ai effectués> »Puis poussez-les :
git push origin my-contrib # utilise le nom de la branche défini précédemmentUtilisez le lien du résultat de git push pour créer la Pull Request !
Extensions recommandées
GoHugo le site web maintient une liste d’extensions sympas à avoir dans votre éditeur de choix lorsque vous utilisez GoHugo.
Si vous utilisez VSCode, utilisez au moins ces deux extensions :