From 46a37eb60989008ddf70b50de78563fd4883d117 Mon Sep 17 00:00:00 2001 From: Lukas Tenbrink Date: Wed, 30 Jul 2025 11:21:57 +0200 Subject: [PATCH] Add an areas section. --- engine/unit_tests.rst | 6 - index.rst | 10 +- maintainers/about.rst | 4 - maintainers/introduction.rst | 4 + organization/areas.rst | 258 +++++++++++++++++++++++ triage/team_trackers.rst | 392 +---------------------------------- 6 files changed, 274 insertions(+), 400 deletions(-) delete mode 100644 engine/unit_tests.rst delete mode 100644 maintainers/about.rst create mode 100644 maintainers/introduction.rst create mode 100644 organization/areas.rst diff --git a/engine/unit_tests.rst b/engine/unit_tests.rst deleted file mode 100644 index 0104554..0000000 --- a/engine/unit_tests.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. _doc_unit_testing: - -Unit testing -============ - -See also the `current documentation for unit tests `_. diff --git a/index.rst b/index.rst index cd38c10..e9c23c4 100644 --- a/index.rst +++ b/index.rst @@ -113,6 +113,14 @@ Community support .. Below is the main table-of-content tree of the documentation website. It is hidden on the page itself, but it makes up the sidebar for navigation. +.. toctree:: + :hidden: + :maxdepth: 1 + :caption: Organization + :name: sec-organization + + organization/areas + .. toctree:: :hidden: :maxdepth: 1 @@ -185,6 +193,6 @@ Community support :caption: Maintainers documentation :name: sec-maintainers - maintainers/about + maintainers/introduction maintainers/merge_queue maintainers/building_releases diff --git a/maintainers/about.rst b/maintainers/about.rst deleted file mode 100644 index 7182ae2..0000000 --- a/maintainers/about.rst +++ /dev/null @@ -1,4 +0,0 @@ -About Godot maintainers -======================= - -TODO diff --git a/maintainers/introduction.rst b/maintainers/introduction.rst new file mode 100644 index 0000000..a8cfe5f --- /dev/null +++ b/maintainers/introduction.rst @@ -0,0 +1,4 @@ +Introduction for new maintainers +================================ + +TODO diff --git a/organization/areas.rst b/organization/areas.rst new file mode 100644 index 0000000..ada1c2d --- /dev/null +++ b/organization/areas.rst @@ -0,0 +1,258 @@ +.. _doc_areas: + +Areas and teams +=============== + +Godot is organized into areas, most of which has a designated team working on them. +This page lists these areas and explains their goals and how they're organized. + +You can find information about the teams on the `godot website `_, as well +as their `current priorities `_. + +For more information about the different GitHub labels, please see the +`labels documentation `__. + +Core +---- + +Low-level Core API: Object, Variant, templates, base nodes like Node, Viewport, etc. (everything under core and scene/main). + +* Triage: `Core issue triage `_ +* RC channel: `#core `_ +* GitHub team: `godotengine/core `_ +* GitHub label: ``topic:core`` · `issues `_ · `PRs `_ + +Input +~~~~~ + +* GitHub team: `godotengine/input `_ +* RC channel: `#input `_ +* GitHub label: ``topic:input`` · `issues `_ · `PRs `_ + +GUI +--- + +Everything that inherits Control (everything under scene/gui) and can be used to build Graphical User Interfaces (both game UI and editor tools). + +* Triage: `GUI issue triage `_ +* RC channel: `#gui `_ +* GitHub team: `godotengine/gui-nodes `_ +* GitHub label: ``topic:gui`` · `issues `_ · `PRs `_ + +2D Nodes +-------- + +* GitHub team: `godotengine/2d-nodes `_ +* GitHub label: ``topic:2d`` · `issues `_ · `PRs `_ + +3D Nodes +-------- + +* GitHub team: `godotengine/3d-nodes `_ +* GitHub label: ``topic:3d`` · issues · PRs + +Editor +------ + +All things related to the editor, both tools and usability (editor). + +* Triage: `Editor issue triage `_ +* RC channel: `godotengine/editor `_ +* GitHub labels + * ``topic:editor`` · `issues `_ · `PRs `_ + * ``topic:export`` · `issues `_ · `PRs `_ + * ``topic:i18n`` · `issues `_ · `PRs `_ + * ``topic:plugin`` · `issues `_ · `PRs `_ +* GitHub teams + * `godotengine/2d-editor `_ + * `godotengine/3d-editor `_ + * `godotengine/debugger `_ + * `godotengine/docs `_ + * `godotengine/script-editor `_ + * `godotengine/usability `_ + +Scripting +--------- + +Umbrella team for all the scripting languages usable with Godot. +Encompasses some shared core components (Object, ClassDB, MethodBind, ScriptLanguage, etc.) and language specific implementations in dedicated subteams. + +GDExtension +~~~~~~~~~~~ + +GDExtension and godot-cpp. + +* Triage: `GDExtension issue triage `_ +* RC Channel: `#gdextension `_ +* GitHub team: `godotengine/gdextension `_ +* GitHub label: ``topic:gdextension`` · `issues `_ · `PRs `_ + +GDScript +~~~~~~~~ + +GDScript language implementation. + +* Triage: `GDScript issue triage `_ +* RC channel: `#gdscript `_ +* GitHub team: `godotengine/gdscript `_ +* GitHub label: ``topic:gdscript`` · `issues `_ · `PRs `_ + +C# / .NET / Mono +~~~~~~~~~~~~~~~~ + +* Triage: `Dotnet issue triage `_ +* RC channel: `#dotnet `_ +* GitHub team: `godotengine/dotnet `_ +* GitHub label: ``topic:dotnet`` · `issues `_ · `PRs `_ + +Buildsystem +----------- + +Tools and scripts that we use to compile and maintain Godot, both for development purpose (SCons, CI) and releases (official build containers). + +* Triage: `Buildsystem issue triage `_ +* RC channel: `#buildsystem `_ +* GitHub team: `godotengine/buildsystem `_ +* GitHub label: ``topic:buildsystem`` · `issues `_ · `PRs `_ + +Platforms +--------- + +Platform specific layers that reside in platform, with shared components (Unix, Win32, Apple, etc.) in drivers. + +* Triage: `Platforms issue triage `_ +* RC channels + * `#platforms `_ + * `#apple `_ + * `#android `_ + * `#web `_ +* GitHub teams + * `godotengine/android `_ + * `godotengine/ios `_ + * `godotengine/linux-bsd `_ + * `godotengine/macos `_ + * `godotengine/uwp `_ + * `godotengine/web `_ + * `godotengine/windows `_ +* GitHub labels + * ``topic:porting`` · `issues `_ · `PRs `_ + * ``topic:android`` · `issues `_ · `PRs `_ + * ``topic:ios`` · `issues `_ · `PRs `_ + * ``topic:linuxbsd`` · `issues `_ · `PRs `_ + * ``topic:macos`` · `issues `_ · `PRs `_ + * ``topic:uwp`` · `issues `_ · `PRs `_ + * ``topic:web`` · `issues `_ · `PRs `_ + * ``topic:windows`` · `issues `_ · `PRs `_ + +Animation +--------- + +Nodes and features for 2D and 3D animation and IK workflows. + +* Triage: `Animation team Issue Triage `__ +* RC channel: `#animation `__ +* GitHub team: `godotengine/animation `__ +* GitHub label: ``topic:animation`` · `issues `__ · `PRs `__ + +Audio +----- + +All audio-related features, from low-level AudioServer and drivers to high-level nodes and effects. + +* Triage: `Audio issue triage `__ +* RC channel: `#audio `__ +* GitHub team: `godotengine/audio `_ +* GitHub label: ``topic:audio`` · `issues `_ · `PRs `_ + +Import +------ + +Asset import pipeline for 2D (textures) and 3D (scenes, models, animations, etc.). + +* Triage: `Asset pipeline issue triage `__ +* RC channel: `#asset-pipeline `__ +* GitHub team: `godotengine/import `_ +* GitHub label: ``topic:import`` · `issues `_ · `PRs `_ + +Networking +---------- + +Networked multiplayer, RPCs and replication, HTTP/TCP/UDP/DNS, WebSockets, ENet, encryption. + +* Triage: `Network issue triage `_ +* RC channel: `#networking `_ +* GitHub team: `godotengine/network `_ +* GitHub labels + * ``topic:network`` · `issues `_ · `PRs `_ + * ``topic:multiplayer`` · `issues `_ · `PRs `_ + +Physics +------- + +Physics servers and their implementation in 2D and 3D. + +* Triage: `Physics issue triage `_ +* RC channel: `#physics `_ +* GitHub team: `godotengine/physics `_ +* GitHub label: ``topic:physics`` · `issues `_ · `PRs `_ + +Rendering +--------- + +Rendering server and RenderingDevice implementations (Vulkan, OpenGL), as well as the actual rendering techniques implemented using those graphics APIs. + +* Triage: `Rendering issue triage `_ +* RC channel: `#rendering `_ +* GitHub teams + * `godotengine/rendering `_ + * `godotengine/shaders `_ +* GitHub labels + * ``topic:rendering`` · `issues `_ · `PRs `_ + * ``topic:shaders`` · `issues `_ · `PRs `_ + +VFX / Tech Art / Particles +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +* Triage: `Particles issue triage `_ +* RC channel: `#vfx-tech-art `_ +* GitHub label: ``topic:particles`` · `issues `_ · `PRs `_ + +XR +-- + +Augmented (AR) and virtual reality (VR). + +* Triage: `XR issue triage `_ +* RC channel: `#xr `_ +* GitHub team: `godotengine/xr `_ +* GitHub label: ``topic:xr`` · `issues `_ · `PRs `_ + +Navigation +---------- + +* Triage: `Navigation issue triage `_ +* RC channel: `#navigation `_ +* GitHub team: `godotengine/navigation `_ +* GitHub label: ``topic:navigation`` · `issues `_ · `PRs `_ + +Documentation +------------- + +Documentation for the engine and its systems. +Note that, while there is a dedicated documentation team, all other teams are expected to contribute to the documentation +for their area. + +* GitHub team: `godotengine/documentation `_ +* GitHub label: ``documentation`` · `issues `_ · `PRs `_ + +Tests +----- + +Tests for the engine and its systems. +Note that, while there is a dedicated tests team, all other teams are expected to contribute to the tests +for their area. + +* GitHub team: `godotengine/tests `_ +* GitHub label: ``topic:tests``_ · `issues `_ · `PRs `_ + +See also the `current documentation for unit tests `_. diff --git a/triage/team_trackers.rst b/triage/team_trackers.rst index 070e1a9..9526ac2 100644 --- a/triage/team_trackers.rst +++ b/triage/team_trackers.rst @@ -1,10 +1,6 @@ Team triage trackers -------------------- -.. raw:: html - - - To search for PRs with requested reviews from a team, add ``team-review-requested:`` to the search bar, followed by the team name (see below for each team, the link opens a search on GitHub). Note that @@ -12,389 +8,7 @@ this *doesn’t* show PRs that have already been reviewed by that team, any review comments at all, from any member of a specific team, will remove the request, so this is not always helpful. -Some GitHub labels aren’t neatly covered by trackers, below is a list of -teams and labels that don’t (currently) have trackers: \* 2D Nodes: - -`godotengine/2d-nodes `__ -- ``topic:2d`` -`issues `__ -`PRs `__ -\* 3D Nodes: - -`godotengine/3d-nodes `__ -- ``topic:3d`` -`issues `__ -`PRs `__ -\* Documentation: - -`godotengine/documentation `__ -- ``documentation`` -`issues `__ -`PRs `__ -\* Tests: - -`godotengine/tests `__ -- ``topic:tests`` -`issues `__ -`PRs `__ +You can find the various areas and their respective trackers on the page +:ref:`doc_areas`. -For more information about the different GitHub labels, please see the -`labels -documentation `__. - -.. raw:: html - - - -Animation -~~~~~~~~~ - -Tracked in: \* `Animation Team Issue -Triage `__ (This -tracker doesn’t follow the pattern of the other ones) - -RC channel: \* -`#animation `__ - -GitHub team: \* -`godotengine/animation `__ - -GitHub label: \* ``topic:animation`` -`issues `__ -`PRs `__ - -Asset Pipeline -~~~~~~~~~~~~~~ - -Tracked in: \* `Asset Pipeline Issue -Triage `__ (This -tracker doesn’t follow the pattern of the other ones) - -RC channel: \* -`asset-pipeline `__ - -GitHub team: \* -`godotengine/import `__ - -GitHub label: \* ``topic:import`` -`issues `__ -`PRs `__ - -Audio -~~~~~ - -Tracked in: \* `Audio Issue -Triage `__ - -RC channel: \* `#audio `__ - -GitHub team: \* -`godotengine/audio `__ - -GitHub label: \* ``topic:audio`` -`issues `__ -`PRs `__ - -Buildsystem -~~~~~~~~~~~ - -Tracked in: \* `Buildsystem Issue -Triage `__ - -RC channel: \* -`#buildsystem `__ - -GitHub team: \* -`godotengine/buildsystem `__ - -GitHub label: \* ``topic:buildsystem`` -`issues `__ -`PRs `__ - -Core -~~~~ - -Tracked in: \* `Core Issue -Triage `__ - -RC channel: \* `#core `__ - -Categories: \* Threads \* Math \* String \* Input \* Resource \* -Templates \* Debugger \* Variant \* Main \* Viewport \* IO \* -Object/ClassDB - -These categories largely match the specific folders the classes are in. - -GitHub team: \* -`godotengine/core `__ - -GitHub labels: \* ``topic:core`` -`issues `__ -`PRs `__ -\* ``topic:input`` -`issues `__ -`PRs `__ - -Editor -~~~~~~ - -Tracked in: \* `Editor Issue -Triage `__ - -RC channel: \* `#editor `__ - -Categories: \* Docks: Editor docks (Inspector, Scene etc.) and dock -layout \* 2D Editor: 2D editor and related features, including GUI \* 3D -Editor: 3D editor and related features, including gizmos \* Shader -Editor: Includes visual shaders \* Script Editor: Text editing (Scripts, -TextFiles) \* Animation: ``AnimationPlayer``, ``AnimationTree`` and -animation-related systems \* Tiles: ``TileMapLayer`` and ``TileSet`` -editors \* Project Export: Export dialog, export process and related -features \* Project Manager: Project Manager and its components \* -Plugins: Related to editor plugins, both user (e.g. ``EditorInterface``) -and native (any plugin not covered by other categories) \* Game View: -Issues relating to the embedded game view \* AssetLib: AssetLib -integration with the editor \* Debugger: Related to editor/runtime -interactions \* Systems: Misc editor systems not covered by other -categories \* Usability: User experience, editor visuals (themes etc.) -\* File System: Related to ``EditorFileSystem``, cache, UIDs, previews -\* Asset Pipeline: Asset import, models and materials, imported -animations - -GitHub teams: \* -`godotengine/2d-editor `__ -\* -`godotengine/3d-editor `__ -\* -`godotengine/debugger `__ -\* -`godotengine/docks `__ -\* -`godotengine/script-editor `__ -\* -`godotengine/usability `__ - -GitHub label: \* ``topic:editor`` -`issues `__ -`PRs `__ -\* ``topic:export`` -`issues `__ -`PRs `__ -\* ``topic:i18n`` -`issues `__ -`PRs `__ -\* ``topic:plugin`` -`issues `__ -`PRs `__ - -GDExtension -~~~~~~~~~~~ - -Tracked in: \* `GDExtension Issue -Triage `__ - -RC Channel: \* -`#gdextension `__ - -GitHub team: \* -`godotengine/gdextension `__ - -GitHub label: \* ``topic:gdextension`` -`issues `__ -`PRs `__ - -GDScript -~~~~~~~~ - -Tracked in: \* `GDScript Issue -Triage `__ - -RC channel: \* -`#gdscript `__ - -GitHub team: \* -`godotengine/gdscript `__ - -GitHub label: \* ``topic:gdscript`` -`issues `__ -`PRs `__ - -GUI -~~~ - -Tracked in: \* `GUI Issue -Triage `__ - -RC channel: \* `#gui `__ - -GitHub team: \* -`godotengine/gui-nodes `__ - -GitHub label: \* ``topic:gui`` -`issues `__ -`PRs `__ - -Navigation -~~~~~~~~~~ - -Tracked in: \* `Navigation Issue -Triage `__ - -RC channel: \* -`#navigation `__ - -GitHub team: \* -`godotengine/navigation `__ - -GitHub label: \* ``topic:navigation`` -`issues `__ -`PRs `__ - -.NET / Mono -~~~~~~~~~~~ - -Tracked in: \* `.NET Issue -Triage `__ (Internal -tracker) - -RC channel: \* `#dotnet `__ - -GitHub team: \* -`godotengine/dotnet `__ - -GitHub label: \* ``topic:dotnet`` -`issues `__ -`PRs `__ - -Network -~~~~~~~ - -Tracked in: \* `Network Issue -Triage `__ - -RC channel: \* -`#networking `__ - -GitHub team: \* -`godotengine/network `__ - -GitHub labels: \* ``topic:multiplayer`` -`issues `__ -`PRs `__ -\* ``topic:network`` -`issues `__ -`PRs `__ - -Particles -~~~~~~~~~ - -Tracked in: \* `Particles Issue -Triage `__ - -RC channel: \* -`#vfx-tech-art `__ - -GitHub team: \* No dedicated team (currently) - -GitHub label: \* ``topic:particles`` -`issues `__ -`PRs `__ - -Physics -~~~~~~~ - -Tracked in: \* `Physics Issue -Triage `__ - -RC channel: \* -`#physics `__ - -GitHub team: \* -`godotengine/physics `__ - -GitHub label: \* ``topic:physics`` -`issues `__ -`PRs `__ - -Platforms -~~~~~~~~~ - -Tracked in: \* `Platforms Issue -Triage `__ - -RC channel: \* -`#platforms `__ - -Has a “Platform” field for each platform type to fill in. - -GitHub teams: \* -`godotengine/android `__ -\* -`godotengine/ios `__ -\* -`godotengine/linux-bsd `__ -\* -`godotengine/macos `__ -\* -`godotengine/uwp `__ -\* -`godotengine/web `__ -\* -`godotengine/windows `__ - -GitHub labels: \* ``topic:porting`` -`issues `__ -`PRs `__ -\* ``platform:android`` -`issues `__ -`PRs `__ -\* ``platform:ios`` -`issues `__ -`PRs `__ -\* ``platform:linuxbsd`` -`issues `__ -`PRs `__ -\* ``platform:macos`` -`issues `__ -`PRs `__ -\* ``platform:uwp`` -`issues `__ -`PRs `__ -\* ``platform:web`` -`issues `__ -`PRs `__ -\* ``platform:windows`` -`issues `__ -`PRs `__ - -Rendering -~~~~~~~~~ - -Tracked in: \* `Rendering Issue -Triage `__ - -RC channel: \* -`#rendering `__ - -GitHub teams: \* -`godotengine/rendering `__ -\* -`godotengine/shaders `__ - -GitHub labels: \* ``topic:rendering`` -`issues `__ -`PRs `__ -\* ``topic:shaders`` -`issues `__ -`PRs `__ - -XR -~~ - -Tracked in: \* `XR Issue -Triage `__ - -RC channel: \* `#xr `__ - -GitHub team: \* -`godotengine/xr `__ - -GitHub label: \* ``topic:xr`` -`issues `__ -`PRs `__ +Note that some GitHub labels aren’t neatly covered by trackers.