Comment participer au projet avec GitHub (Fork / Update / PR)

Comprendre simplement comment fonctionne GitHub

GitHub est l’endroit où le code de CraftMyWebsite est stocké.
C’est un outil qui permet à plusieurs personnes de travailler ensemble sur le même projet, sans risquer de casser le site.

Tout le développement du CMS passe par GitHub.

Le CORE du CMS

Le CORE est la partie principale de CraftMyWebsite.
C’est le cœur du CMS, celui qui gère tout le fonctionnement.

Modifier le CORE est sensible. C’est pour cela qu’on n’autorise pas les modifications directes sur le projet officiel.

Le principe du fork (le plus important)

Un fork, c’est une copie du projet sur votre propre compte GitHub.

Concrètement :

• Vous copiez le projet officiel

• Vous travaillez sur votre copie

• Le projet principal reste intact

Cela vous permet de faire des modifications sans aucun risque.

👉 Ce principe fonctionne pour :

• Le CORE

• Les packages

• Les thèmes
  Et pour n’importe quel projet GitHub.

Branche importante : dev

Le développement de la prochaine version du CMS se fait uniquement sur la branche dev.

Vous devez donc toujours travailler à partir de cette branche.

Lien direct :
https://github.com/CraftMyWebsite/cmw-core/tree/dev

Étape 1 : Créer un compte GitHub

1. Allez sur https://github.com

2. Créez un compte gratuit

3. Connectez-vous

Étape 2 : Forker la branche dev

1. Ouvrez le lien de la branche dev

2. Cliquez sur Fork (en haut à droite)

3. GitHub crée une copie du projet sur votre compte

Vous avez maintenant votre propre version du CORE.

Outil recommandé pour travailler

Pour modifier et envoyer du code, il est recommandé d’utiliser :

1. Un IDE (éditeur de code)
Un IDE rend la lecture et la modification du code beaucoup plus faciles.
Parmi les bons choix :

• Visual Studio Code (gratuit)

• PhpStorm (payant, très bon pour PHP)

• Sublime Text (léger)

Avec un IDE :

• La coloration du code est automatique

• Les erreurs sont plus faciles à voir

• Tu peux installer des extensions utiles (lint, formatteur, etc.)

2. GitHub Desktop (facultatif mais conseillé)
Si tu n’es pas à l’aise avec Git en ligne de commande, GitHub Desktop te permet :

• De synchroniser ton fork

• De faire des commits

• De pousser tes modifications
  sans utiliser la ligne de commande.

Tu peux le télécharger ici :
https://desktop.github.com

Étape 3 : Récupérer le projet sur ton ordinateur

Deux méthodes :

Méthode simple (sans Git)

• Sur ton fork, clique sur Code

• Télécharge le projet en ZIP

• Décompresse-le

Méthode avec Git / GitHub Desktop

• Clone ton fork

• Ouvre le dossier avec ton IDE

Étape 4 : Faire tes modifications

Maintenant tu peux :

• Corriger une faute

• Résoudre un petit bug

• Améliorer une description

• Nettoyer ou clarifier du code

Même une petite amélioration est utile.

Étape 5 : Mettre ton fork à jour

Le projet évolue souvent.
Avant d’envoyer ta modification, assure-toi que ton fork est à jour avec la branche dev du projet officiel.

Cela évite les conflits et rend l’intégration plus facile.

Étape 6 : Qu’est-ce qu’une Pull Request ?

Une Pull Request (PR) est une demande pour dire :

“J’ai fait une modification, est-ce qu’on peut l’ajouter au projet principal ?”

C’est le cœur de la contribution.

Quand tu crées une Pull Request :

1. Tu compares ta version avec la version officielle

2. Tu expliques ce que tu as changé

3. Les mainteneurs relisent ton travail

Une Pull Request sert à :

• Présenter tes modifications

• Discuter si quelque chose doit être ajusté

• Valider que tout est correct avant d’ajouter au projet

Étape 7 : Créer la Pull Request

1. Sur GitHub, va dans l’onglet Pull Requests

2. Clique sur New Pull Request

3. Vérifie que :

   • La base est la branche dev du projet officiel

   • La comparaison est ta branche sur ton fork

4. Ajoute un message simple décrivant ta modification

Exemple de message :

Correction d’un bug sur la validation d’un formulaire

Puis clique sur Create Pull Request.

Après l’envoi

Ta Pull Request sera relue.
On peut te demander :

• Une petite correction

• Une explication

• De mettre à jour un détail

C’est normal, c’est fait pour améliorer la qualité du CMS.

Pour bien débuter

Si tu veux commencer doucement :

• Corrige une faute

• Améliore une phrase

• Ajoute un commentaire

• Clarifie une ligne de code

Chaque contribution compte, même petite.

CraftMyWebsite progresse grâce à toi.