Up to date

This page is up to date for Godot 4.3. If you still find outdated information, please open an issue.

Contribuer au code

La possibilité d'étudier, d'utiliser, de modifier et de redistribuer les modifications du code source du moteur sont les droits fondamentaux que la licence MIT de Godot vous accorde, le rendant gratuit et logiciel open source.

En tant que tel, tout le monde est autorisé à modifier le code source de Godot, et à envoyer ces modifications au projet en amont sous la forme d'un patch (un fichier texte décrivant les changements d'une manière prête à appliquer) ou - dans le flux de travail moderne que nous utilisons - via une "pull request" (PR), c'est-à-dire une proposition de fusionner directement un ou plusieurs commits Git (patches) dans la branche de développement principal.

Contribuer aux modifications de code en amont présente deux grands avantages :

  • Votre code sera examiné et amélioré par d'autres développeurs, et sera maintenu directement dans le projet en amont, vous n'aurez donc pas à réappliquer vos propres modifications chaque fois que vous passez à une version plus récente. D'un autre côté, cela implique une responsabilité, car vos modifications doivent être suffisamment génériques pour être utiles à tous les utilisateurs, et pas seulement à votre projet ; dans certains cas, il peut être pertinent de conserver vos modifications uniquement pour votre propre projet, si elles sont trop spécifiques.

  • The whole community will benefit from your work, and other contributors will behave the same way, contributing code that will be beneficial to you. At the time of this writing, over 2,000 developers have contributed code changes to the engine!

Pour assurer une bonne collaboration et qualité globale, les développeurs Godot appliquent certaines règles pour les contributions au code, par exemple concernant le style à utiliser dans le code C ++ (indentation, crochets, etc.) ou le flux de travail Git et PR.

Un bon point de départ est de rechercher les problèmes marqués comme good first issue sur GitHub.

Voir aussi

Les détails techniques sur le workflow PR sont décrits dans une section spécifique, Flux de travail pour les Pull Request.

Les détails sur les directives de style de code et l'outil clang-format utilisé pour les appliquer sont décrits dans Lignes directrices pour le style du code.

Toutes les pull requests doivent passer par un processus de révision avant d'être acceptées. En fonction de l'ampleur des modifications, il peut s'écouler un certain temps avant que le responsable de la partie modifiée du moteur ne fournisse son avis. Nous apprécions tous nos contributeurs et leur demandons d'être patients pendant ce temps, car il est normal que dans un projet open source comme Godot, il y ait beaucoup plus de contributions que de personnes qui les valident.

Pour s'assurer que votre temps et vos efforts ne sont pas gaspillés, il est recommandé de vérifier l'idée d'abord avant de la mettre en œuvre et de la soumettre à un examen en tant que PR. À cette fin, Godot a un système de proposition. Son utilisation est encouragée pour planifier des changements et en discuter avec la communauté. Les détails de mise en œuvre peuvent également être discutés avec d'autres contributeurs sur le Chat des contributeurs de Godot.

Note

Les propositions ne sont nécessaires que pour travailler sur une amélioration ou une nouvelle fonctionnalité. Les rapports de bogue sont suffisants pour résoudre les problèmes.

Tester et signaler les problèmes (issues)

Une autre excellente façon de contribuer à le moteur est de tester les versions de développement ou la branche de développement et de signaler des problèmes. Il est également utile de signaler les problèmes découverts dans les versions stables, de sorte qu'ils puissent être fixés dans la branche de développement et dans les futures versions de maintenance.

Tester les versions de développement

Pour aider avec les tests, vous avez plusieurs possibilités :

  • Compilez le moteur à partir de la source vous-même, en suivant les instructions de la page Compiler pour votre plate-forme.

  • Tester les binaires officiels de pré-publication lorsqu'ils sont annoncés (généralement sur le blog et d'autres plates-formes communautaires), comme les compilations candidates alpha, bêta et release.

  • Tester les constructions officieuses « fiables » de la branche de développement ; il suffit de demander aux membres de la communauté des fournisseurs fiables. Dans la mesure du possible, il est préférable d’utiliser des binaires officiels ou de compiler vous même, pour être sûr de la provenance de vos binaires.

Comme mentionné précédemment, il est également utile de garder les yeux ouverts pour les bugs potentiels qui pourraient encore être présents dans les versions stables, en particulier lors de l'utilisation de certaines fonctionnalités niche du moteur qui pourraient être moins testées par les développeurs.

Signaler un problème(issue) sur GitHub

Godot uses GitHub's issue tracker for bug reports. When you start filing a bug report, you’ll be given a form to fill out. Please try to follow it so that all issues are consistent and provide the required information.

Contribuer à la documentation

Il existe deux ressources distinctes appelées "documentation" dans Godot :

  • The class reference. This is the documentation for the complete Godot API as exposed to GDScript and the other scripting languages. It can be consulted offline, directly in Godot's code editor, or online at Godot Class Reference. To contribute to the class reference, you have to edit the XML file corresponding to the class and make a pull request. See Contribuer à la référence des classes and Class reference primer for more details.

  • Les tutoriels et la documentation du moteur et ses traductions. C'est la partie que vous êtes en train de lire, qui est distribuée au format HTML. Son contenu est généré à partir de fichiers de texte brut au format reStructured Text (rst), auxquels vous pouvez contribuer par des pull requests sur le dépôt GitHub godot-docs. Voir Contribuer à la documentation pour plus de détails.

Contribuer aux traductions

Pour rendre Godot accessible à tous, y compris aux utilisateurs qui préfèrent les ressources dans leur langue maternelle plutôt qu'en anglais, notre communauté aide à traduire l'éditeur de Godot et sa documentation dans de nombreuses langues.

Voir Localisation de l'éditeur et de la documentation pour plus de détails.