|
1 | | -# Guide de Contribution |
2 | | - |
3 | | -Merci de votre intérêt pour ce projet ! Nous accueillons toutes les contributions, qu'il s'agisse de signaler un bug, d'ajouter une fonctionnalité ou d'améliorer la documentation. Veuillez suivre ces instructions pour contribuer efficacement. |
4 | | - |
5 | | -## Comment Contribuer ? |
6 | | - |
7 | | -### 1. Signaler un Bug |
8 | | -Si vous trouvez un bug, ouvrez une issue en incluant : |
9 | | -- Une description claire du problème. |
10 | | -- Les étapes pour reproduire le bug. |
11 | | -- Les résultats attendus et obtenus. |
12 | | -- Toute information système pertinente (OS, version du logiciel, etc.). |
13 | | - |
14 | | -### 2. Suggérer une Amélioration ou une Fonctionnalité |
15 | | -Avant de proposer une nouvelle fonctionnalité, consultez les issues existantes pour éviter les doublons. Si votre idée est nouvelle : |
16 | | -- Décrivez clairement la fonctionnalité souhaitée. |
17 | | -- Expliquez pourquoi elle est utile. |
18 | | -- Proposez éventuellement une implémentation. |
19 | | - |
20 | | -### 3. Soumettre une Pull Request (PR) |
21 | | -1. **Forkez** le dépôt et clonez votre copie. |
22 | | -2. **Créez une branche** pour votre contribution : |
23 | | - ```bash |
24 | | - git checkout -b feature/ma-fonctionnalite |
25 | | - ``` |
26 | | -3. **Faites vos modifications** en respectant les conventions du projet. |
27 | | -4. **Testez** votre code avant de le soumettre. |
28 | | -5. **Faites un commit** avec un message clair : |
29 | | - ```bash |
30 | | - git commit -m "Ajout de [fonctionnalité]" |
31 | | - ``` |
32 | | -6. **Poussez** votre branche et ouvrez une Pull Request. |
33 | | - |
34 | | -## Bonnes Pratiques |
35 | | -- Respectez la structure et le style du code. |
36 | | -- Documentez votre code si nécessaire. |
37 | | -- Assurez-vous que toutes les modifications passent les tests existants. |
38 | | -- Soyez courtois et respectueux dans vos interactions. |
39 | | - |
40 | | -## Contact |
41 | | -Si vous avez des questions, ouvrez une issue ou contactez un mainteneur du projet. |
42 | | - |
43 | | -Merci pour votre contribution ! 🚀 |
| 1 | +# Guide de Contribution |
| 2 | + |
| 3 | +Merci de votre intérêt pour ce projet ! Nous accueillons toutes les contributions, qu'il s'agisse de signaler un bug, d'ajouter une fonctionnalité ou d'améliorer la documentation. Veuillez suivre ces instructions pour contribuer efficacement. |
| 4 | + |
| 5 | +## Comment Contribuer ? |
| 6 | + |
| 7 | +### 1. Signaler un Bug |
| 8 | +Si vous trouvez un bug, ouvrez une issue en incluant : |
| 9 | +- Une description claire du problème. |
| 10 | +- Les étapes pour reproduire le bug. |
| 11 | +- Les résultats attendus et obtenus. |
| 12 | +- Toute information système pertinente (OS, version du logiciel, etc.). |
| 13 | + |
| 14 | +### 2. Suggérer une Amélioration ou une Fonctionnalité |
| 15 | +Avant de proposer une nouvelle fonctionnalité, consultez les issues existantes pour éviter les doublons. Si votre idée est nouvelle : |
| 16 | +- Décrivez clairement la fonctionnalité souhaitée. |
| 17 | +- Expliquez pourquoi elle est utile. |
| 18 | +- Proposez éventuellement une implémentation. |
| 19 | + |
| 20 | +### 3. Soumettre une Pull Request (PR) |
| 21 | +1. **Forkez** le dépôt et clonez votre copie. |
| 22 | +2. **Créez une branche** pour votre contribution : |
| 23 | + ```bash |
| 24 | + git checkout -b feature/ma-fonctionnalite |
| 25 | + ``` |
| 26 | +3. **Faites vos modifications** en respectant les conventions du projet. |
| 27 | +4. **Testez** votre code avant de le soumettre. |
| 28 | +5. **Faites un commit** avec un message clair : |
| 29 | + ```bash |
| 30 | + git commit -m "Ajout de [fonctionnalité]" |
| 31 | + ``` |
| 32 | +6. **Poussez** votre branche et ouvrez une Pull Request. |
| 33 | + |
| 34 | +## Bonnes Pratiques |
| 35 | +- Respectez la structure et le style du code. |
| 36 | +- Documentez votre code si nécessaire. |
| 37 | +- Assurez-vous que toutes les modifications passent les tests existants. |
| 38 | +- Soyez courtois et respectueux dans vos interactions. |
| 39 | + |
| 40 | +## Contact |
| 41 | +Si vous avez des questions, ouvrez une issue ou contactez un mainteneur du projet. |
| 42 | + |
| 43 | +Merci pour votre contribution ! 🚀 |
0 commit comments