Merge pull request #2 from Ryuka25/feature/update-readme-for-better-c…

…ollaboration

feat: update readme for better collaboration

Readme.md

@@ -41,4 +41,43 @@ console.log(filter.censor('Hoano ny tay')); //Hoano ny ***
 // Retirer des mots de la liste des gros mots
 filter.removeWords('kindy');
 console.log(filter.censor('Raha kindy ny olona')); // Raha kindy ny olona
-```
+```
+
+## Collaboration
+
+### Installation du projet en local
+
+- Installer les dépendances :
+
+```bash
+npm install
+```
+
+### Conventions de développement
+
+- **Branches Git** : Utiliser la convention `feature/nom-de-la-feature`, `fix/description-du-fix`, etc.
+- **Commits Git** : Structurer les messages de commit selon le format suivant :
+
+    ```text
+    <type>: <description courte>
+
+    [Description optionnelle, plus détaillée]
+    ```
+
+    **Types possibles :**
+
+    - `feat`: Ajout d'une nouvelle fonctionnalité
+    - `fix`: Correction de bug
+    - `refactor`: Réorganisation ou amélioration du code sans ajout de fonctionnalités
+    - `docs`: Modifications de la documentation
+    - `test`: Ajout ou modification de tests
+    - `chore`: Autres tâches (par exemple, mise à jour des dépendances)
+
+### Tests
+
+- Tous les nouveaux modules et fonctionnalités doivent inclure des tests unitaires.
+- Les tests peuvent être exécutés localement avec la commande suivante :
+
+    ```bash
+    npm run test
+    ```