Julien Martin
9cb4162165
- Framework: Flutter web - Pages: Login, inscription, dashboards - Services: API client, authentification, gestion d'état - Intégration avec backend NestJS - Dockerfile pour déploiement web
74 lines
2.2 KiB
Markdown
74 lines
2.2 KiB
Markdown
# 🚀 Guide de contribution – Projet P'titsPas (Flutter)
|
||
|
||
Bienvenue ! Ce guide explique comment collaborer efficacement sur ce projet Flutter.
|
||
|
||
---
|
||
|
||
## 📌 Branches Git
|
||
|
||
Le projet suit une stratégie de branches simple et efficace :
|
||
|
||
| Branche | Rôle |
|
||
|---------------|---------------------------------------------|
|
||
| `main` | Production (version stable déployée) |
|
||
| `develop` | Intégration (version en cours de test) |
|
||
| `feature/XXX` | Développement d’une nouvelle fonctionnalité |
|
||
| `fix/XXX` | Correction de bug |
|
||
| `hotfix/XXX` | Patch urgent sur `main` |
|
||
|
||
---
|
||
|
||
## ✅ Cycle de développement
|
||
|
||
1. **Crée une branche à partir de `develop`**
|
||
```bash
|
||
git checkout develop
|
||
git pull origin develop
|
||
git checkout -b feature/FRONT-XXX-nom-fonctionnalite
|
||
|
||
2. Travaille localement + commit régulièrement
|
||
|
||
Commits clairs et concis :
|
||
Nom de la branche: Fonctionnalité push
|
||
|
||
```bash
|
||
git commit -m "FRONT-021: ajout du widget zone enfants"
|
||
```
|
||
|
||
3. Pousse ta branche
|
||
|
||
Exemple
|
||
```bash
|
||
git push origin feature/FRONT-XXX-nom
|
||
|
||
|
||
4. Ouvre une Pull Request vers develop
|
||
|
||
Ps : **La PR vers develop est faite lorsque une fonctionnalité du ticket à été fait et testé ou lorsque tous le ticket est finis**
|
||
- Titre : [FRONT-021] Widget zone enfants
|
||
|
||
- Description : ce que tu as fait, ce qu’il reste à tester
|
||
- Lie le ticket associé (ex: Fixes #21)
|
||
|
||
5. Relecture & Merge
|
||
- Au moins 1 review nécessaire
|
||
- Pas de commit direct sur develop ou main
|
||
|
||
6. Une fois merge, supprime la branche distante:
|
||
|
||
PS: **La branche est supprimé que lorsque tout le ticket a été consommé**
|
||
```bash
|
||
git push origin --delete feature/FRONT-XXX-nom
|
||
```
|
||
|
||
🧼 Règles de bonne conduite
|
||
|
||
- Une PR = une seule fonctionnalité ou correction
|
||
|
||
- Code commenté si logique complexe
|
||
|
||
- Garder les noms de variables/dossiers clairs et en anglais
|
||
|
||
- Pas de code mort ou non utilisé
|
||
|
||
- Tester les commandes du workflow(dans le .github) afin d'être sur de ne pas avoir des erreur dans le code et pour etre sur de passer les tests du Workflow |