Contribuer

Retrouvez ici toutes les informations vous permettant de nous aider à modifier ce wiki

Bienvenue ! Ce guide vous accompagnera pas à pas dans la contribution au wiki du projet Blocaria sur GitHub.

📋 Pré-requis

Après l'installation, ouvrez votre terminal et configurez votre nom et email (ceux utilisés pour GitHub) :

git config --global user.name "Votre Nom"
git config --global user.email "[email protected]"

Rendez-vous sur wiki-blocaria
Cliquez sur le bouton Fork en haut à droite pour créer une copie du repository sur votre compte.

Copiez le lien de votre fork puis dans votre terminal :

git clone https://github.com/VOTRE-NOM-UTILISATEUR/wiki-blocaria.git
cd wiki-blocaria

Créer une branche par sujet traité pour bien organiser vos contributions :

git checkout -b nom-de-votre-branche

Exemple : git checkout -b ajout-guide-capture

Utilisez Visual Studio Code pour éditer les fichiers markdown (.md).
Vous pouvez également créer de nouveaux fichiers, par exemple comment-creer-ma-box.md.

Exemple de structure markdown simple :

# Titre principal

## Sous-titre

Votre contenu ici...

- Liste à puces
- Second point

[Un lien utile](http://example.com)

Dans votre terminal, ajoutez et validez vos changements :

git add .
git commit -m "Ajout du guide sur les métiers"

Envoyez vos modifications sur GitHub :

git push origin nom-de-votre-branche

Retournez sur votre fork du projet GitHub.
Cliquez sur Compare & pull request.
Décrivez votre contribution clairement puis validez en cliquant sur Create pull request.

Restez clair et concis dans vos explications.
Vérifiez l'orthographe et la grammaire.
Structurez bien vos pages markdown.
Utilisez les prévisualisations markdown de Visual Studio Code (Ctrl + Shift + V) avant de soumettre.

N'hésitez pas à créer une issue sur GitHub pour demander de l'aide ou poser une question.

Merci pour votre contribution ! ✨

Last updated 3 months ago