Restructure the main navigation:

- Rename "Testing and reporting issues" to "Providing feedback"
- Add "issue reporting" article, with TBD guidelines
- Move "issue triage" to "other" since it's not relevant for most people.
This commit is contained in:
Lukas Tenbrink
2026-01-21 13:37:23 +01:00
parent e6638742fb
commit 4afc1470c4
12 changed files with 45 additions and 37 deletions

View File

@@ -7,3 +7,11 @@ source,destination
/organization/pull_requests/review_guidelines.html,/pull_requests/review_guidelines.html /organization/pull_requests/review_guidelines.html,/pull_requests/review_guidelines.html
/organization/pull_requests/testing.html,/pull_requests/testing.html /organization/pull_requests/testing.html,/pull_requests/testing.html
/organization/pull_requests/merge_guidelines.html,/pull_requests/merge_guidelines.html /organization/pull_requests/merge_guidelines.html,/pull_requests/merge_guidelines.html
/reporting_issues/first_steps.html,/feedback/reporting_issues.html
/reporting_issues/bisecting.html,/feedback/bisecting.html
/other/ideas.html,/feedback/ideas.html
/triage/about.html,/other/triage/about.html
/triage/guidelines.html,/other/triage/guidelines.html
/triage/release_blockers.html,/other/triage/release_blockers.html
/triage/workflow.html,/other/triage/workflow.html
/triage/sprint_instructions.html,/other/triage_sprints.html
1 source destination
7 /organization/pull_requests/review_guidelines.html /pull_requests/review_guidelines.html
8 /organization/pull_requests/testing.html /pull_requests/testing.html
9 /organization/pull_requests/merge_guidelines.html /pull_requests/merge_guidelines.html
10 /reporting_issues/first_steps.html /feedback/reporting_issues.html
11 /reporting_issues/bisecting.html /feedback/bisecting.html
12 /other/ideas.html /feedback/ideas.html
13 /triage/about.html /other/triage/about.html
14 /triage/guidelines.html /other/triage/guidelines.html
15 /triage/release_blockers.html /other/triage/release_blockers.html
16 /triage/workflow.html /other/triage/workflow.html
17 /triage/sprint_instructions.html /other/triage_sprints.html

View File

@@ -1,7 +1,7 @@
.. _doc_contributing_ideas: .. _doc_contributing_ideas:
Contributing ideas and change proposals Proposing and discussing ideas
======================================= ==============================
We are always looking for suggestions about how to improve the engine. User feedback We are always looking for suggestions about how to improve the engine. User feedback
is the main driving force behind our decision-making process, and limitations that is the main driving force behind our decision-making process, and limitations that

View File

@@ -1,25 +1,30 @@
.. _doc_reporting_issues: .. _doc_reporting_issues:
Getting started Testing and reporting issues
=============== ============================
A great way of contributing to the engine is to test development releases Godot uses `GitHub's issue tracker <https://github.com/godotengine/godot/issues>`_
or the development branch and to report issues. It is also helpful to report for bug reports. When you start filing a bug report, youll be given a form to
issues discovered in stable releases, so that they can be fixed in fill out. Please try to follow it so that all issues are consistent and provide
the development branch and in future maintenance releases. the required information.
.. _doc_testing_development_versions:
Testing development versions Testing development versions
---------------------------- ----------------------------
A great way of contributing to the engine is to test development releases
or the development branch and to report issues found therein.
To help with the testing, you have several possibilities: To help with the testing, you have several possibilities:
- Compile the engine from source yourself, following the instructions of the - **Compile the engine from source yourself**, following the instructions of the
`Compiling <https://docs.godotengine.org/en/latest/engine_details/development/compiling/index.html>`__ page for your platform. `Compiling <https://docs.godotengine.org/en/latest/engine_details/development/compiling/index.html>`__ page for your platform.
- Test official pre-release binaries when they are announced (usually on the - **Test official pre-release binaries** when they are announced (usually on the
blog and other community platforms), such as alpha, beta and release candidate (RC) builds. blog and other community platforms), such as alpha, beta and release candidate (RC) builds.
- Test "trusted" unofficial builds of the development branch; just ask - **Test "trusted" unofficial builds of the development branch**; just ask
community members for reliable providers. Whenever possible, it's best to community members for reliable providers. Whenever possible, it's best to
use official binaries or to compile yourself though, to be sure about the use official binaries or to compile yourself though, to be sure about the
provenance of your binaries. provenance of your binaries.
@@ -28,11 +33,3 @@ As mentioned previously, it is also helpful to keep your eyes peeled for
potential bugs that might still be present in the stable releases, especially potential bugs that might still be present in the stable releases, especially
when using some niche features of the engine which might get less testing by when using some niche features of the engine which might get less testing by
the developers. the developers.
Filing an issue on GitHub
-------------------------
Godot uses `GitHub's issue tracker <https://github.com/godotengine/godot/issues>`_
for bug reports. When you start filing a bug report, youll be given a form to
fill out. Please try to follow it so that all issues are consistent and provide
the required information.

View File

@@ -29,23 +29,12 @@ for your topic of interest. You can also use the search function in the top-left
.. toctree:: .. toctree::
:hidden: :hidden:
:maxdepth: 1 :maxdepth: 1
:caption: Testing and reporting issues :caption: Providing feedback
:name: sec-reporting-issues :name: sec-providing-feedback
reporting_issues/first_steps feedback/reporting_issues
reporting_issues/bisecting feedback/ideas
feedback/bisecting
.. toctree::
:hidden:
:maxdepth: 1
:caption: Issue Triage
:name: sec-triage
triage/about
triage/workflow
triage/guidelines
triage/release_blockers
triage/sprint_instructions
.. toctree:: .. toctree::
:hidden: :hidden:
@@ -88,7 +77,8 @@ for your topic of interest. You can also use the search function in the top-left
:caption: Other :caption: Other
:name: sec-other :name: sec-other
other/ideas other/triage/index
other/triage_sprints
other/translations other/translations
other/website other/website
other/demos other/demos

View File

@@ -48,7 +48,7 @@ Provide feedback
To get started, please visit our section on :ref:`sharing ideas and proposing changes <doc_contributing_ideas>`. To get started, please visit our section on :ref:`sharing ideas and proposing changes <doc_contributing_ideas>`.
- **Test development versions** - **Test development versions**
While it is recommended to use the stable releases for your projects, you can :ref:`help us test <doc_reporting_issues>` While it is recommended to use the stable releases for your projects, you can :ref:`help us test <doc_testing_development_versions>`
dev releases, betas, and release candidates by opening a copy of your project in them and checking what problems this dev releases, betas, and release candidates by opening a copy of your project in them and checking what problems this
might introduce or maybe even solves. Make sure to have a backup ready, to avoid potential irreversible changes. might introduce or maybe even solves. Make sure to have a backup ready, to avoid potential irreversible changes.

13
other/triage/index.rst Normal file
View File

@@ -0,0 +1,13 @@
Bugsquad and triage
===================
This section explains the workflow and guidelines of the :ref:`triage team <doc_areas>`.
.. toctree::
:maxdepth: 1
:name: sec-triage
about
workflow
guidelines
release_blockers