Modèles de fichiers (Templates)

Pour travailler selon les standards de l’industrie, vous devez structurer vos dépôts avec des documents clairs. Voici des modèles de fichiers réutilisables à copier-coller directement dans vos projets.

1. Modèle de README.md professionnel

Le fichier README.md est la vitrine de votre projet. Il doit expliquer clairement le but de l’application, comment l’installer et comment l’utiliser.

Créez un fichier README.md à la racine de votre projet et collez-y ce contenu :

# 🚀 Nom de l'application

> Une description courte et percutante (1 à 2 phrases max) du rôle et de la valeur ajoutée de votre projet.

[![Status](https://img.shields.io/badge/status-active-success.svg)]()
[![License](https://img.shields.io/badge/license-MIT-blue.svg)]()

---

## 📋 Table des matières

- [Présentation](#-présentation)
- [Fonctionnalités](#-fonctionnalités)
- [Stack technique](#-stack-technique)
- [Installation](#-installation)
- [Utilisation](#-utilisation)
- [Contribution](#-contribution)
- [Licence](#-licence)

---

## 🔍 Présentation

Expliquez en détail le contexte de votre application. Pourquoi a-t-elle été créée ? À quel besoin répond-elle ?

---

## ✨ Fonctionnalités

- **Fonctionnalité 1** : Description de ce qu'elle fait.
- **Fonctionnalité 2** : Description de ce qu'elle fait.
- **Fonctionnalité 3** : Description de ce qu'elle fait.

---

## 🛠️ Stack technique

- **Frontend** : Langages/Frameworks (ex: HTML/CSS, React, Astro)
- **Backend** : Langages/Frameworks (ex: Node.js, Python, Go)
- **Base de données** : (ex: PostgreSQL, SQLite)
- **DevOps** : (ex: Docker, GitHub Actions)

---

## ⚙️ Installation

Suivez ces étapes pour exécuter le projet localement :

1. **Cloner le dépôt** :
   ```bash
   git clone https://github.com/votre-username/votre-depot.git
   cd votre-depot

Installer les dépendances :
Terminal window
```
npm install
```
Configurer les variables d’environnement : Copiez le fichier d’exemple et remplissez-le :
Terminal window
```
cp .env.example .env
```
Lancer le serveur de développement :
Terminal window
```
npm run dev
```

🚀 Utilisation

Expliquez brièvement comment utiliser l’application après installation :

# Exemple pour lancer les tests
npm run test

🤝 Contribution

Les contributions sont les bienvenues ! Pour contribuer :

Forkez le projet.
Créez votre branche de fonctionnalité (git checkout -b feature/AmazingFeature).
Commitez vos modifications (git commit -m 'feat: Add some AmazingFeature').
Pushez votre branche (git push origin feature/AmazingFeature).
Ouvrez une Pull Request.

📄 Licence

Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus de détails.

---

## 2. Modèle de Pull Request (PR)

Placer un fichier de modèle à l'emplacement `.github/pull_request_template.md` dans votre dépôt permet d'ouvrir automatiquement un formulaire pré-rempli lorsque vous créez une PR sur GitHub.

*Créez le fichier `.github/pull_request_template.md` et collez-y ce contenu :*

```markdown
## 📝 Description

> Décrivez brièvement les modifications apportées par cette Pull Request et leur but.

Lien de l'Issue associée : Fixes # (numéro de l'issue)

## 🛠️ Type de changement

- [ ] 🐛 Correction de bug (Non-breaking change qui corrige un problème)
- [ ] ✨ Nouvelle fonctionnalité (Non-breaking change qui ajoute une fonction)
- [ ] 💥 Changement majeur / Breaking change (Correction ou fonction modifiant le comportement existant)
- [ ] 📝 Documentation (Mise à jour des fichiers Markdown)
- [ ] ⚙️ Refactoring / DevOps (Amélioration du code sans impact fonctionnel, CI/CD)

## 🧪 Validation & Tests

- [ ] J'ai exécuté mes tests localement avant d'ouvrir la PR.
- [ ] Mes modifications ne génèrent aucune nouvelle erreur ou avertissement dans la console.

## 📸 Captures d'écran (Si applicable)

*Ajoutez des captures d'écran ou GIFs animés pour illustrer les changements visuels.*

3. Modèles d’Issues (GitHub Issue Templates)

Pour forcer les utilisateurs et collègues à structurer leurs rapports de bugs ou leurs demandes, vous pouvez créer des fichiers Markdown dans le dossier .github/ISSUE_TEMPLATE/.

Rapport de Bug
Demande de Fonctionnalité

Fichier .github/ISSUE_TEMPLATE/bug_report.md :

---
name: 🐛 Rapport de Bug
about: Signaler un problème ou un comportement inattendu pour nous aider à l'améliorer.
title: '[BUG] : Description courte du bug'
labels: bug, triage
assignees: ''
---

## 📝 Description du bug

Une description claire et concise de ce qu'est le bug.

## 🔄 Étapes pour reproduire

1. Aller sur '...'
2. Cliquer sur '....'
3. Faire défiler jusqu'à '...'
4. Constater l'erreur.

## 🎯 Comportement attendu

Une description claire et concise de ce qui aurait dû se passer.

## 📸 Captures d'écran

Si possible, ajoutez des captures d'écran pour illustrer votre problème.

## 💻 Environnement

- **Système d'exploitation** : (ex: Windows 11, macOS Sequoia)
- **Navigateur** : (ex: Chrome 120, Firefox 119)
- **Version de l'application** : (ex: v1.0.2)

Fichier .github/ISSUE_TEMPLATE/feature_request.md :

---
name: ✨ Demande de Fonctionnalité
about: Proposer une nouvelle idée ou une amélioration pour ce projet.
title: '[FEATURE] : Description courte de l''idée'
labels: enhancement, feature
assignees: ''
---

## ❓ Votre suggestion est-elle liée à un problème ?

Une description claire et concise du problème rencontré. Ex: "Je suis frustré quand..."

## 💡 Description de la solution proposée

Une description claire et concise de ce que vous aimeriez voir se produire.

## 🔄 Alternatives envisagées

Une description claire et concise des solutions alternatives ou des contournements que vous avez envisagés.

## 📋 Contexte supplémentaire

Ajoutez ici toute autre information, capture d'écran ou schéma décrivant votre demande.

4. Modèle de CONTRIBUTING.md

Le fichier CONTRIBUTING.md explique comment rejoindre le projet, configurer l’environnement local de développement et soumettre des modifications.

Créez un fichier CONTRIBUTING.md à la racine de votre projet et collez-y ce contenu :

# 🤝 Guide de Contribution

Merci de l'intérêt que vous portez à notre projet ! Pour garantir une collaboration fluide et agréable, veuillez suivre ces quelques lignes de conduite.

## 🛠️ Configuration de l'environnement local

1. Forkez et clonez le dépôt.
2. Créez une branche dédiée à vos modifications :
   ```bash
   git switch -c feature/ma-fonctionnalite
   # ou pour une correction de bug
   git switch -c bugfix/nom-du-bug

Installez les dépendances locales et lancez les tests avant de coder.

📏 Règles de style et de commits

Commits : Rédigez des commits clairs en anglais ou en français, idéalement en respectant la norme Conventional Commits (ex: feat: add database support).
Qualité du code : Assurez-vous que le code est bien formaté et ne génère aucun avertissement au build.

📨 Soumission de vos modifications (Pull Request)

Mettez votre branche locale à jour par rapport à la branche principale (main) d’origine :
Terminal window
```
git pull origin main
```
Pushez votre branche vers votre fork distant :
Terminal window
```
git push origin feature/ma-fonctionnalite
```
Ouvrez une Pull Request sur le dépôt principal en remplissant bien le modèle fourni.
Un des mainteneurs effectuera une revue de code et fusionnera vos modifications après validation !