mirror of
https://github.com/godotengine/godot-contributing-docs.git
synced 2026-02-25 02:34:39 +03:00
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.
This commit is contained in:
@@ -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/creating_pull_requests
|
||||||
pull_requests/review_guidelines
|
pull_requests/review_guidelines
|
||||||
pull_requests/testing
|
pull_requests/testing
|
||||||
pull_requests/merge_guidelines
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:hidden:
|
:hidden:
|
||||||
@@ -85,4 +84,4 @@ for your topic of interest. You can also use the search function in the top-left
|
|||||||
other/demos
|
other/demos
|
||||||
other/benchmarks
|
other/benchmarks
|
||||||
other/godot-cpp
|
other/godot-cpp
|
||||||
other/maintenance_releases
|
other/release_management/index
|
||||||
|
|||||||
13
other/release_management/index.rst
Normal file
13
other/release_management/index.rst
Normal file
@@ -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
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
.. _doc_creating_pull_requests:
|
.. _doc_creating_pull_requests:
|
||||||
|
|
||||||
Creating pull requests
|
How to create pull requests
|
||||||
======================
|
===========================
|
||||||
|
|
||||||
.. highlight:: shell
|
.. highlight:: shell
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
.. _doc_pull_request_guidelines:
|
.. _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.
|
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.
|
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
|
Your pull request description should, as clearly and succinctly as possible, explain all the necessary
|
||||||
a typo, a single sentence description is appropriate. However, if your change is large, or may affect multiple systems
|
information to understand the changes you made.
|
||||||
in potentially unexpected ways, we expect you to be more thorough with your explanation.
|
|
||||||
|
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:
|
Here are the components of a thorough pull request description:
|
||||||
|
|
||||||
|
|||||||
@@ -4,9 +4,13 @@ Testing pull requests
|
|||||||
=====================
|
=====================
|
||||||
|
|
||||||
Many people are developing new features or fixing bugs on GitHub.
|
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.
|
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 <doc_pr_review_guidelines>`
|
||||||
|
and improve the chance of the PR being merged.
|
||||||
|
|
||||||
Thanks to GitHub Actions, all `pull requests <https://github.com/godotengine/godot/pulls>`__
|
Thanks to GitHub Actions, all `pull requests <https://github.com/godotengine/godot/pulls>`__
|
||||||
have continuous builds available. These builds let you try out pull requests
|
have continuous builds available. These builds let you try out pull requests
|
||||||
without having to compile anything from source.
|
without having to compile anything from source.
|
||||||
|
|||||||
Reference in New Issue
Block a user