From 137572d4a129053545a74abbdaac9393ebce315e Mon Sep 17 00:00:00 2001 From: Lukas Tenbrink Date: Fri, 20 Feb 2026 01:18:00 +0100 Subject: [PATCH] Create 'release management' section for merge guidelines and maintenance release instructions. Rename "pull request guidelines" to "pull request rules and guidelines". Explain how to contribute by testing pull requests a bit better. Improve "Explain your contributions" w.r.t. overly verbose text. --- index.rst | 3 +-- other/release_management/index.rst | 13 +++++++++++++ .../maintenance_releases.rst | 0 .../release_management}/merge_guidelines.rst | 0 pull_requests/creating_pull_requests.rst | 4 ++-- pull_requests/pull_request_guidelines.rst | 16 ++++++++++------ pull_requests/testing.rst | 6 +++++- 7 files changed, 31 insertions(+), 11 deletions(-) create mode 100644 other/release_management/index.rst rename other/{ => release_management}/maintenance_releases.rst (100%) rename {pull_requests => other/release_management}/merge_guidelines.rst (100%) diff --git a/index.rst b/index.rst index 2363f1f..4ab064e 100644 --- a/index.rst +++ b/index.rst @@ -47,7 +47,6 @@ for your topic of interest. You can also use the search function in the top-left pull_requests/creating_pull_requests pull_requests/review_guidelines pull_requests/testing - pull_requests/merge_guidelines .. toctree:: :hidden: @@ -85,4 +84,4 @@ for your topic of interest. You can also use the search function in the top-left other/demos other/benchmarks other/godot-cpp - other/maintenance_releases + other/release_management/index diff --git a/other/release_management/index.rst b/other/release_management/index.rst new file mode 100644 index 0000000..090c64f --- /dev/null +++ b/other/release_management/index.rst @@ -0,0 +1,13 @@ +Release management +================== + +This section explains the workflow and guidelines of the release management team. + +It is intended to document internal procedures, and is not actionable by regular Godot contributors. + +.. toctree:: + :maxdepth: 1 + :name: sec-release-management + + merge_guidelines + maintenance_releases diff --git a/other/maintenance_releases.rst b/other/release_management/maintenance_releases.rst similarity index 100% rename from other/maintenance_releases.rst rename to other/release_management/maintenance_releases.rst diff --git a/pull_requests/merge_guidelines.rst b/other/release_management/merge_guidelines.rst similarity index 100% rename from pull_requests/merge_guidelines.rst rename to other/release_management/merge_guidelines.rst diff --git a/pull_requests/creating_pull_requests.rst b/pull_requests/creating_pull_requests.rst index 3c8821c..cbc5748 100644 --- a/pull_requests/creating_pull_requests.rst +++ b/pull_requests/creating_pull_requests.rst @@ -1,7 +1,7 @@ .. _doc_creating_pull_requests: -Creating pull requests -====================== +How to create pull requests +=========================== .. highlight:: shell diff --git a/pull_requests/pull_request_guidelines.rst b/pull_requests/pull_request_guidelines.rst index fd287df..c6716dd 100644 --- a/pull_requests/pull_request_guidelines.rst +++ b/pull_requests/pull_request_guidelines.rst @@ -1,9 +1,9 @@ .. _doc_pull_request_guidelines: -Pull request guidelines -======================= +Pull request rules and guidelines +================================= -This page contains guidelines relevant for contributing to any area of Godot. +This page contains rules and guidelines relevant for contributing to any area of Godot. When contributing to any particular area, please also refer to its respective guidelines. @@ -60,9 +60,13 @@ Explain your contributions When submitting a pull request, please make use of the pull request description. -Your pull request description should be appropriate for the complexity of the change. For example, if you're just fixing -a typo, a single sentence description is appropriate. However, if your change is large, or may affect multiple systems -in potentially unexpected ways, we expect you to be more thorough with your explanation. +Your pull request description should, as clearly and succinctly as possible, explain all the necessary +information to understand the changes you made. + +For example, if you're just fixing a typo, a single sentence description is appropriate. + +However, if your change is large, or may affect multiple systems in potentially unexpected ways, +we expect you to be more thorough with your explanation. Here are the components of a thorough pull request description: diff --git a/pull_requests/testing.rst b/pull_requests/testing.rst index 0768750..df5d851 100644 --- a/pull_requests/testing.rst +++ b/pull_requests/testing.rst @@ -4,9 +4,13 @@ Testing pull requests ===================== Many people are developing new features or fixing bugs on GitHub. -To help with engine development, you may be asked to test those pull requests +To help with engine development, you can test those pull requests with a Godot build that includes code from the pull request in question. +Your feedback on any pull request is helpful to improve it and to test +whether it works as intended. This can speed up the :ref:`review process ` +and improve the chance of the PR being merged. + Thanks to GitHub Actions, all `pull requests `__ have continuous builds available. These builds let you try out pull requests without having to compile anything from source.