Contribuer à ygégé
Pour des informations détaillées sur le développement, consultez la documentation développeur dans le dépôt GitHub :
- Guide de contribution complet - Guide détaillé pour contribuer
- Pipeline CI/CD - Comprendre les builds automatiques
- Workflow de preview - Tester les PRs avec Docker
- Workflow de release - Processus de release
Merci de votre intérêt pour contribuer au projet ygégé ! Cette page décrit les façons dont vous pouvez aider, nos politiques de contribution, et comment démarrer avec votre première Issue ou Pull Request (PR).
Même si vous ne pouvez pas contribuer de code, vous pouvez toujours aider ygégé ! Les principales façons de contribuer sont de tester, signaler des problèmes, et améliorer la documentation. Le code, la documentation et d'autres contributions sont tous les bienvenus—consultez les sections ci-dessous pour plus de détails.
Signaler des problèmes
Nous utilisons GitHub Issues pour suivre les bugs, améliorations et demandes de fonctionnalités.
- Veuillez consulter la documentation des issues pour des conseils sur la soumission d'issues claires et utiles.
- Avant d'ouvrir une nouvelle issue, cherchez dans les issues existantes pour éviter les doublons.
- Pour les questions d'utilisation ou le dépannage, veuillez utiliser les Discussions.
Développer du code
ygégé est écrit en Rust. Si vous avez de l'expérience avec Rust, nous accueillons vos contributions !
- Consultez notre guide de développement pour savoir comment configurer votre environnement de développement, compiler ygégé depuis les sources et soumettre des PRs.
- Nous suivons un workflow "fork and PR". Si c'est nouveau pour vous, consultez le guide de fork de GitHub.
Améliorer la documentation
La documentation est extrêmement précieuse ! La documentation utilisateur est disponible sur ce site Docusaurus, et la documentation développeur se trouve dans le dossier docs/ du dépôt.
- Pour suggérer des changements, ouvrez une Pull Request avec vos améliorations.
- Pour les changements majeurs de documentation, veuillez d'abord ouvrir une issue ou une discussion.
Tester
Tester est l'une des façons les plus faciles et les plus précieuses de contribuer.
- Utilisez simplement ygégé, et si vous trouvez des bugs ou des comportements inattendus, ouvrez une issue.
- Si vous avez des suggestions d'améliorations ou de nouvelles fonctionnalités, vous pouvez aussi les soumettre sous forme d'issues.
Compiler et exécuter ygégé
- Pour compiler ygégé depuis les sources, suivez le guide de compilation manuel.
- Pour les utilisateurs Docker, consultez le guide de déploiement Docker pour les instructions sur l'utilisation de l'image officielle ou la construction de votre propre image.
Merci d'aider à améliorer ygégé ! Chaque contribution—grande ou petite—fait une différence.