Lab Niveau 14 — Collaboration Open Source

Progression dans cet atelier 0%

Fork & Upstream GitHub CLI gh Fichiers clés Vérifications de sécurité

Cours associé

Complète d’abord 12. Open Source & Standards avant ce lab.

Objectifs

• Simuler le workflow de contribution open source via Fork.
• Configurer les fichiers clés de gouvernance (CONTRIBUTING.md, CODEOWNERS, LICENSE).
• Installer et s’authentifier avec GitHub CLI (gh).
• Créer une Pull Request depuis le terminal avec gh pr create.

---

Exercice Pratique

Dans cet exercice, vous allez simuler une contribution à un projet open source en configurant votre dépôt local et en créant des fichiers de gouvernance de qualité professionnelle.

Étape 1 : Configurer les relations distantes (Remotes)

1. Imaginez que vous travaillez sur votre propre Fork (origin).
2. Ajoutez le dépôt de l’organisation officielle comme source de synchronisation distante (upstream) :

   git remote add upstream https://github.com/joinhashcode/workshops.git

3. Listez vos dépôts distants configurés pour vérifier que vous avez bien origin et upstream d’actifs :

   git remote -v

Étape 2 : Mettre en place la gouvernance du dépôt

Dans votre dépôt local de TP :

1. Créez un fichier CONTRIBUTING.md à la racine contenant les étapes clés pour cloner, tester et proposer un correctif de bug sur votre projet.
2. Créez un dossier .github/ à la racine et créez-y un fichier CODEOWNERS pour assigner automatiquement les relecteurs :

   # Assigner l'administrateur pour toutes les modifications de code source
   /src/ @votre-identifiant-github

3. Ajoutez un fichier LICENSE à la racine avec les termes d’une licence open source courante (comme la licence MIT).

Étape 3 : Utiliser GitHub CLI (gh)

1. Installez GitHub CLI sur votre machine (si ce n’est pas déjà fait, suivez les instructions de l’Atelier 12).
2. Connectez-vous à votre compte GitHub depuis votre terminal habituel :

   gh auth login

3. Créez une nouvelle branche locale feature-governance.
4. Ajoutez et commitez vos nouveaux fichiers de gouvernance.
5. Utilisez la commande GitHub CLI pour pousser votre branche et ouvrir directement votre Pull Request depuis le terminal :

   gh pr create --title "docs: add repository governance files" --body "This PR adds README, CONTRIBUTING, CODEOWNERS, and LICENSE files."

---

Checklist de validation

• Le remote upstream est configuré et visible dans git remote -v.
• Le fichier CONTRIBUTING.md détaille le processus de contribution.
• Le fichier .github/CODEOWNERS assigne correctement les fichiers de /src/.
• Le fichier LICENSE (ex: MIT) est présent à la racine du dépôt.
• La Pull Request a été créée avec succès en ligne de commande avec gh pr create.

---

Compétences acquises

• Workflow de Forking et synchronisation
• Utilisation professionnelle de GitHub CLI (gh)
• Configuration de la gouvernance de dépôt (Licence, Codeowners)
• Standards de contribution Open Source

---

Fiches de révision

Question

Quelle commande affiche tous les dépôts distants (remotes) configurés et leurs URLs ?

Cliquer pour révéler la réponse

Réponse

git remote -v

Cliquer pour voir la question

Question

Comment cloner un dépôt GitHub avec GitHub CLI ?

Cliquer pour révéler la réponse

Réponse

gh repo clone <propriétaire>/<dépôt>

Cliquer pour voir la question

Question

Où doit-on placer le fichier CODEOWNERS ?

Cliquer pour révéler la réponse

Réponse

À la racine du projet, dans le dossier .github/ ou dans le dossier docs/.

Cliquer pour voir la question

---

Évaluation des connaissances

Quelle commande ajoute le dépôt d'origine comme source amont ?

A git remote add origin <url> B git remote add upstream <url> C git remote set-url upstream <url> D git upstream add <url>

Quelle commande GitHub CLI permet de lister les Pull Requests ouvertes sur le dépôt actuel ?

A gh pr list B gh pr status C gh pr show D gh pr view

Quelle licence open source permet d'utiliser, copier, modifier et distribuer le code presque sans restriction ?

A Licence MIT B GPL v3 C Creative Commons BY-NC D Licence propriétaire HashCode