贡献文档

This guide explains how to contribute to Godot’s documentation, be it by writing or reviewing pages.

参见

If you want to translate pages or the class reference from English to other languages, read 编辑器和文档本地化.

入门

To modify or create pages in the reference manual, you need to edit .rst files in the godot-docs GitHub repository. Modifying those pages in a pull request triggers a rebuild of the online documentation upon merging.

参见

有关Git用法和拉取请求工作流程的详细信息, 请参阅 拉取请求工作流程 页面. 它描述的关于主godotengine/godot存储库的大部分内容, 这对文档存储库也是有效的.

警告

The class reference’s source files are in the Godot engine repository. We generate the Godot API section of this documentation from them. If you want to update the description of a class, its methods, or properties, read 为类参考手册贡献.

What is the Godot documentation

The Godot documentation is intended as a comprehensive reference manual for the Godot game engine. It is not meant to contain step-by-step tutorials, except for two game creation tutorials in the Getting Started section.

We strive to write factual content in an accessible and well-written language. To contribute, you should also read:

  1. The 文档编写指南. There, you will find rules and recommendations to write in a way that everyone understands.

  2. The content guidelines. They explain the principles we follow to write the documentation and the kind of content we accept.

Contributing changes

Pull Requests should use the master branch by default. Only make Pull Requests against other branches (e.g. 2.1 or 3.0) if your changes only apply to that specific version of Godot.

Though less convenient to edit than a wiki, this Git repository is where we write the documentation. Having direct access to the source files in a revision control system is a plus to ensure our documentation quality.

Editing existing pages

To edit an existing page, locate its .rst source file and open it in your favorite text editor. You can then commit the changes, push them to your fork, and make a pull request. Note that the pages in classes/ should not be edited here. They are automatically generated from Godot’s XML class reference. See 为类参考手册贡献 for details.

参见

To build the manual and test changes on your computer, see 使用 Sphinx 构建手册.

Editing pages online

You can edit the documentation online by clicking the Edit on GitHub link in the top-right of every page.

Doing so takes you to the GitHub text editor. You need to have a GitHub account and to log in to use it. Once logged in, you can propose change like so:

  1. 点击”Edit on GitHub”按钮.

  2. On the GitHub page you’re taken to, click the pencil icon in the top-right corner near the Raw, Blame, and Delete buttons. It has the tooltip “Fork this project and edit the file”.

  3. Edit the text in the text editor.

  4. At the bottom of the web page, summarize the changes you made and click the button Propose file change. Make sure to replace the placeholder “Update file.rst” by a short but clear one-line description, as this is the commit title.

  5. On the following screens, click the Create pull request button until you see a message like Username wants to merge 1 commit into godotengine:master from Username:patch-1.

Another contributor will review your changes and merge them into the docs if they’re good. They may also make changes or ask you to do so before merging.

Adding new pages

Before adding a new page, please ensure that it fits in the documentation:

  1. Look for existing issues or open a new one to see if the page is necessary.

  2. Ensure there isn’t a page that already covers the topic.

  3. Read our Content guidelines.

To add a new page, create a .rst file with a meaningful name in the section you want to add a file to, e.g. tutorials/3d/light_baking.rst.

You should then add your page to the relevant “toctree” (table of contents, e.g. tutorials/3d/index.rst). Add your new filename to the list on a new line, using a relative path and no extension, e.g. here light_baking.

标题

始终以标题和Sphinx引用名称开始页面:

  1. .. _doc_insert_your_title_here:
  3. Insert your title here
  4. ======================

The reference _doc_insert_your_title_here and the title should match.

引用允许使用 :ref: 格式链接到这个页面，例如 :ref:`doc_insert_your_title_here` 将链接到上面的例子页面（注意引用中没有前导下划线）。

Write your titles like plain sentences, without capitalizing each word:

  • Good: Understanding signals in Godot

  • Bad: Understanding Signals In Godot

Only propers nouns, projects, people, and node class names should have their first letter capitalized.

Sphinx and reStructuredText syntax

Check Sphinx’s reST Primer and the official reference for details on the syntax.

Sphinx uses specific reST comments to do specific operations, like defining the table of contents (.. toctree::) or cross-referencing pages. Check the official Sphinx documentation for more details. To learn how to use Sphinx directives like .. note:: or .. seealso::, check out the Sphinx directives documentation.

Adding images and attachments

To add images, please put them in an img/ folder next to the .rst file with a meaningful name and include them in your page with:

  1. .. image:: img/image_name.png

Similarly, you can include attachments, like assets as support material for a tutorial, by placing them into a files/ folder next to the .rst file, and using this inline markup:

  1. :download:`myfilename.zip <files/myfilename.zip>`

许可证

本文档及其包含的每个页面均根据 知识共享署名3.0许可证(CC-BY-3.0)) 的条款发布, 归属于”Juan Linietsky,Ariel Manzur和Godot社区”.

通过贡献GitHub存储库上的文档, 你同意你的更改是根据此许可证分发的.