diff --git a/.github/workflows/check-docs-folder.yml b/.github/workflows/check-docs-folder.yml new file mode 100644 index 0000000..8081354 --- /dev/null +++ b/.github/workflows/check-docs-folder.yml @@ -0,0 +1,38 @@ +name: Check docs folder + +on: + pull_request: + +jobs: + check-docs-folder: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Verify /docs folder existence + run: | + echo "🔎 Vérification de la documentation du projet" + echo "" + + if [ ! -d "docs" ]; then + echo "❌ Dossier /docs manquant" + echo "" + echo "👉 Le projet doit contenir un dossier /docs à la racine du dépôt." + echo "" + echo "📚 Ce dossier est destiné à regrouper :" + echo " - le cahier des charges" + echo " - la documentation fonctionnelle" + echo " - la documentation technique" + echo "" + echo "🛠️ Action attendue :" + echo " 1. Crée le dossier : mkdir docs" + echo " 2. Ajoute au minimum un fichier .txt ou .md" + echo " 3. Commit et pousse les changements" + echo "" + exit 1 + fi + + echo "✅ Dossier /docs trouvé" + echo "📘 La documentation du projet est bien structurée" diff --git a/docs/cahier_des_charges.txt b/docs/cahier_des_charges.txt new file mode 100644 index 0000000..e69de29