Contributing to the class reference

In the class reference, some methods, variables, and signals lack descriptions. Others changed with recent releases and need updates. The developers can’t write the entire reference on their own. Godot needs you, and all of us, to contribute.

Important: If you plan to make large changes, you should create an issue on the godot-docs repository or comment on an existing issue. Doing so lets others know you’re already taking care of a given class.

See also

You can find the writing guidelines for the class reference .

For details on Git usage and the pull request workflow, please refer to the Pull request workflow page.

If you want to translate the class reference from English to another language, see .

See also

Not sure which class to contribute to? Take a look at the class reference’s completion status here.

You can find the source files for the class reference in Godot’s GitHub repository: .

Note

For some modules in the engine’s source code, you’ll find the XML files in the directory instead.

Warning

Warning

Unless you make minor changes, like fixing a typo, we do not recommend using the GitHub web editor to edit the class reference’s XML.

It lacks features to edit XML well, like keeping indentations consistent, and it does not allow amending commits based on reviews.

Also, it doesn’t allow you to test your changes in the engine or with validation scripts as described in How to edit class XML.

When you create a new class or modify the engine’s API, you need to re-generate the XML files in .

To do so, you first need to compile Godot. See the Introduction to the buildsystem page to learn how. Then, execute the compiled Godot binary from the Godot root directory with the --doctool option. For example, if you’re on 64-bit Linux, the command is: