Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
138 lines (101 loc) · 4.21 KB

CONTRIBUTING.md

File metadata and controls

138 lines (101 loc) · 4.21 KB
Raw

🤝 Guide de contribution

🚀 Démarrage rapide

Modifier le contenu

  1. Fork le repository
  2. Cloner votre fork localement
  3. Modifier les fichiers Markdown dans supports/ ou travaux_pratiques/
  4. Tester localement (optionnel) : 
    ./scripts/build_git_module.sh        # Test module Git
./scripts/build_docker_module.sh     # Test module Docker
  5. Commit et push vos modifications
  6. Créer une Pull Request

🤖 Tests automatiques

Dès que vous créez une PR, GitHub Actions va :

  • ✅ Tester la génération des PDFs
  • ✅ Vérifier qu'il n'y a pas d'erreurs LaTeX
  • ✅ Afficher un rapport dans la PR

Pas besoin d'installer LaTeX localement !

📝 Types de contributions

📚 Contenu pédagogique

  • Amélioration des explications
  • Ajout d'exemples pratiques
  • Correction de fautes de frappe
  • Mise à jour des références

Fichiers concernés :

  • supports/module_*/ (modules de base 01-08)
  • supports/modules_additionnels/module_*/ (modules additionnels)
  • travaux_pratiques/tp*/ (TP de base et additionnels)

🔧 Scripts et outils

  • Amélioration des scripts de génération
  • Optimisation des workflows GitHub Actions
  • Correction de bugs de génération PDF

Fichiers concernés :

  • scripts/
  • .github/workflows/

📖 Documentation

  • Mise à jour du README
  • Amélioration de CLAUDE.md
  • Documentation des workflows

⚠️ Points d'attention

Caractères Unicode

❌ Éviter : 🔥 ⚠️ ✅ → ← ↑ ↓ ┌ └ ├ ┤ ●
✅ Utiliser : [FIRE] [WARN] [OK] -> <- ^ v + + + + *

Pourquoi ? LaTeX ne supporte pas tous les caractères Unicode.

Accents français

✅ Conserver : é è à ç ù œ « »
Ces caractères sont correctement supportés par la configuration LaTeX.

Test avant contribution

# Vérifier les caractères problématiques
grep -r "🔥\|⚠️\|✅\|→" supports/ travaux_pratiques/

# Nettoyer si nécessaire  
./scripts/clean_unicode.sh fichier-problematique.md

🔄 Workflow de contribution

Pour les modifications mineures

  1. Éditer directement sur GitHub (icône crayon)
  2. GitHub Actions testera automatiquement
  3. Merger après validation

Pour les modifications importantes

  1. Fork + clone local
  2. Créer une branche : git checkout -b amelioration-module-docker
  3. Faire les modifications
  4. Tester localement (optionnel)
  5. Commit : git commit -m "Amélioration exemples Docker"
  6. Push : git push origin amelioration-module-docker
  7. Pull Request sur GitHub

📖 Documentation workflows : Voir .github/WORKFLOWS.md pour les détails techniques.

📋 Checklist avant PR

  • Les modifications sont testées (ou les tests automatiques passent)
  • Les accents français sont préservés
  • Pas d'emojis ou caractères Unicode problématiques
  • Le contenu suit la structure existante
  • Les exemples de code sont fonctionnels

🐛 Signaler un problème

Bug de génération PDF

  1. Aller dans Issues
  2. Utiliser le template "Bug PDF"
  3. Inclure les logs d'erreur depuis Actions

Erreur de contenu

  1. Aller dans Issues
  2. Préciser le module et chapitre concerné
  3. Proposer une correction si possible

Amélioration suggérée

  1. Aller dans Issues
  2. Utiliser le label "enhancement"
  3. Décrire l'amélioration souhaitée

❓ Questions fréquentes

"Mon PDF ne se génère pas"

➡️ Vérifiez les logs dans Actions. C'est souvent un caractère Unicode problématique.

"Comment ajouter un nouveau module ?"

➡️ Suivre la structure existante dans supports/module_*/ et créer les TP correspondants dans travaux_pratiques/.

"Puis-je modifier les workflows ?"

➡️ Oui ! Mais testez d'abord dans un fork pour éviter de casser la génération pour tout le monde.

"Comment récupérer les PDFs les plus récents ?"

➡️ Releases ou artifacts depuis Actions

🎯 Objectif

Maintenir une formation Linux de qualité professionnelle, toujours à jour, et facilement accessible grâce à l'automatisation.

Merci pour votre contribution ! 🚀