From 4afc1470c40ba80d8ea31f4e708e8639a3f1472a Mon Sep 17 00:00:00 2001 From: Lukas Tenbrink Date: Wed, 21 Jan 2026 13:37:23 +0100 Subject: [PATCH] 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. --- _static/redirects.csv | 8 +++++ {reporting_issues => feedback}/bisecting.rst | 0 {other => feedback}/ideas.rst | 4 +-- .../reporting_issues.rst | 31 +++++++++---------- index.rst | 24 +++++--------- organization/how_to_contribute.rst | 2 +- {triage => other/triage}/about.rst | 0 {triage => other/triage}/guidelines.rst | 0 other/triage/index.rst | 13 ++++++++ {triage => other/triage}/release_blockers.rst | 0 {triage => other/triage}/workflow.rst | 0 .../triage_sprints.rst | 0 12 files changed, 45 insertions(+), 37 deletions(-) rename {reporting_issues => feedback}/bisecting.rst (100%) rename {other => feedback}/ideas.rst (95%) rename reporting_issues/first_steps.rst => feedback/reporting_issues.rst (69%) rename {triage => other/triage}/about.rst (100%) rename {triage => other/triage}/guidelines.rst (100%) create mode 100644 other/triage/index.rst rename {triage => other/triage}/release_blockers.rst (100%) rename {triage => other/triage}/workflow.rst (100%) rename triage/sprint_instructions.rst => other/triage_sprints.rst (100%) diff --git a/_static/redirects.csv b/_static/redirects.csv index cd4b3da..556776e 100644 --- a/_static/redirects.csv +++ b/_static/redirects.csv @@ -7,3 +7,11 @@ source,destination /organization/pull_requests/review_guidelines.html,/pull_requests/review_guidelines.html /organization/pull_requests/testing.html,/pull_requests/testing.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 diff --git a/reporting_issues/bisecting.rst b/feedback/bisecting.rst similarity index 100% rename from reporting_issues/bisecting.rst rename to feedback/bisecting.rst diff --git a/other/ideas.rst b/feedback/ideas.rst similarity index 95% rename from other/ideas.rst rename to feedback/ideas.rst index ce8504d..09073e5 100644 --- a/other/ideas.rst +++ b/feedback/ideas.rst @@ -1,7 +1,7 @@ .. _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 is the main driving force behind our decision-making process, and limitations that diff --git a/reporting_issues/first_steps.rst b/feedback/reporting_issues.rst similarity index 69% rename from reporting_issues/first_steps.rst rename to feedback/reporting_issues.rst index c605433..1a03b26 100644 --- a/reporting_issues/first_steps.rst +++ b/feedback/reporting_issues.rst @@ -1,25 +1,30 @@ .. _doc_reporting_issues: -Getting started -=============== +Testing and reporting issues +============================ -A great way of contributing to the engine is to test development releases -or the development branch and to report issues. It is also helpful to report -issues discovered in stable releases, so that they can be fixed in -the development branch and in future maintenance releases. +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. + +.. _doc_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: -- Compile the engine from source yourself, following the instructions of the +- **Compile the engine from source yourself**, following the instructions of the `Compiling `__ 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. -- 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 use official binaries or to compile yourself though, to be sure about the 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 when using some niche features of the engine which might get less testing by the developers. - -Filing an issue on 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. diff --git a/index.rst b/index.rst index fad728c..dbbf182 100644 --- a/index.rst +++ b/index.rst @@ -29,23 +29,12 @@ for your topic of interest. You can also use the search function in the top-left .. toctree:: :hidden: :maxdepth: 1 - :caption: Testing and reporting issues - :name: sec-reporting-issues + :caption: Providing feedback + :name: sec-providing-feedback - reporting_issues/first_steps - reporting_issues/bisecting - -.. toctree:: - :hidden: - :maxdepth: 1 - :caption: Issue Triage - :name: sec-triage - - triage/about - triage/workflow - triage/guidelines - triage/release_blockers - triage/sprint_instructions + feedback/reporting_issues + feedback/ideas + feedback/bisecting .. toctree:: :hidden: @@ -88,7 +77,8 @@ for your topic of interest. You can also use the search function in the top-left :caption: Other :name: sec-other - other/ideas + other/triage/index + other/triage_sprints other/translations other/website other/demos diff --git a/organization/how_to_contribute.rst b/organization/how_to_contribute.rst index c8bb15f..7e6cab8 100644 --- a/organization/how_to_contribute.rst +++ b/organization/how_to_contribute.rst @@ -48,7 +48,7 @@ Provide feedback To get started, please visit our section on :ref:`sharing ideas and proposing changes `. - **Test development versions** - While it is recommended to use the stable releases for your projects, you can :ref:`help us test ` + While it is recommended to use the stable releases for your projects, you can :ref:`help us test ` 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. diff --git a/triage/about.rst b/other/triage/about.rst similarity index 100% rename from triage/about.rst rename to other/triage/about.rst diff --git a/triage/guidelines.rst b/other/triage/guidelines.rst similarity index 100% rename from triage/guidelines.rst rename to other/triage/guidelines.rst diff --git a/other/triage/index.rst b/other/triage/index.rst new file mode 100644 index 0000000..70a9ba1 --- /dev/null +++ b/other/triage/index.rst @@ -0,0 +1,13 @@ +Bugsquad and triage +=================== + +This section explains the workflow and guidelines of the :ref:`triage team `. + +.. toctree:: + :maxdepth: 1 + :name: sec-triage + + about + workflow + guidelines + release_blockers diff --git a/triage/release_blockers.rst b/other/triage/release_blockers.rst similarity index 100% rename from triage/release_blockers.rst rename to other/triage/release_blockers.rst diff --git a/triage/workflow.rst b/other/triage/workflow.rst similarity index 100% rename from triage/workflow.rst rename to other/triage/workflow.rst diff --git a/triage/sprint_instructions.rst b/other/triage_sprints.rst similarity index 100% rename from triage/sprint_instructions.rst rename to other/triage_sprints.rst