Documentation mise à jour

This commit is contained in:
2025-03-10 07:58:10 +01:00
parent ff61441355
commit 46ab7a92c9
4 changed files with 188 additions and 18 deletions

58
scripts/CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,58 @@
# 🤝 Contribution au projet
Merci de votre intérêt pour ce projet ! Ce guide explique comment contribuer efficacement.
## 🚀 Comment contribuer ?
### 1⃣ Forker et cloner le dépôt
1. Forkez le dépôt sur votre compte Git.
2. Clonez-le en local :
```bash
git clone https://git.abonnel.fr/cedricAbonnel/notes-techniques.git
cd notes-techniques
```
### 2⃣ Créer une branche
Avant de faire vos modifications, créez une nouvelle branche :
```bash
git checkout -b feature/nom-de-votre-feature
```
Remplacez `nom-de-votre-feature` par une description claire de votre ajout ou correction.
### 3⃣ Développer et tester
- Assurez-vous que votre code respecte la structure existante.
- Testez vos scripts avant de proposer une modification.
- Documentez vos changements si nécessaire (ajout d'explication dans `README.md` ou `INSTALL.md`).
### 4⃣ Soumettre une Pull Request (PR)
1. Ajoutez et validez vos changements :
```bash
git add .
git commit -m "Ajout d'une fonctionnalité X"
```
2. Poussez votre branche :
```bash
git push origin feature/nom-de-votre-feature
```
3. Créez une Pull Request depuis l'interface Git en expliquant vos changements.
## 📌 Bonnes pratiques
- **Code clair et lisible** : Commentez si nécessaire.
- **Respect de la structure** : Gardez les fichiers organisés.
- **Petites PRs bien définies** : Une PR = une seule amélioration claire.
- **Discussions ouvertes** : N'hésitez pas à poser des questions ou à proposer des idées.
## 🛠 Signaler un problème
Si vous trouvez un bug ou avez une suggestion, ouvrez une issue avec :
- Une description claire du problème
- Les étapes pour le reproduire
- Le comportement attendu
Merci pour votre contribution ! 🚀