Contribuer au projet
Découvrez comment proposer des modifications, signaler des problèmes ou suggérer des améliorations pour ce projet open source.
Merci de votre intérêt pour contribuer à ce projet. Votre participation est précieuse pour améliorer la qualité et l’utilité de ce dépôt. Ce guide explique comment proposer des modifications, signaler des problèmes ou suggérer des améliorations.
Comment contribuer
Il existe plusieurs façons de contribuer :
- Proposer une nouvelle fonctionnalité
- Corriger un bug
- Améliorer la documentation
- Signaler un problème ou une anomalie
1. Forker et cloner le dépôt
Pour commencer, forkez ce dépôt sur votre compte GitHub, puis clonez-le sur votre machine locale avec la commande suivante :
gh repo clone ejda-chat/ejda-chat
2. Créer une branche
Créez une branche dédiée à votre modification afin de ne pas impacter la branche principale :
git checkout -b nom-de-votre-branche
Utilisez un nom de branche explicite, par exemple correction-typo
ou ajout-fonctionnalite-x
.
3. Effectuer vos modifications
Apportez vos modifications dans le code. Veillez à respecter le style de code et la structure existante du projet. N’utilisez pas d’outils d’intelligence artificielle pour générer du code ou du contenu.
4. Commiter vos changements
Enregistrez vos modifications avec un message de commit clair et descriptif :
git add .
git commit -m "Explication concise de la modification apportée"
5. Pousser la branche sur votre fork
Envoyez votre branche sur votre dépôt distant :
git push origin nom-de-votre-branche
6. Ouvrir une Pull Request
Rendez-vous sur la page GitHub de votre fork, puis cliquez sur "Compare & pull request". Décrivez précisément votre contribution dans le formulaire, en expliquant le contexte, la motivation et l’impact de vos changements.
L’équipe de maintenance examinera votre Pull Request, pourra demander des modifications ou poser des questions, puis l’intégrera si tout est conforme.
Signaler un problème (Issue)
Si vous souhaitez signaler un bug ou proposer une amélioration :
- Accédez à l’onglet "Issues" du dépôt.
- Cliquez sur "New Issue".
- Remplissez le formulaire en décrivant le problème rencontré ou la suggestion d’amélioration. Précisez le contexte, les étapes pour reproduire le bug, et toute information utile.
Bonnes pratiques
- Rédigez des messages de commit clairs et concis.
- Testez vos modifications avant de soumettre une Pull Request.
- Respectez le code de conduite du projet.
Merci de prendre le temps de contribuer à ce projet. Votre aide est essentielle pour son évolution et sa qualité.