From 2423666c17b97c845ee0ba630b6d6dd7c32b650f Mon Sep 17 00:00:00 2001 From: Fabien Potencier Date: Mon, 13 Jan 2025 18:11:38 +0100 Subject: [PATCH] Add information about PR merge commit category --- contributing/code/core_team.rst | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/contributing/code/core_team.rst b/contributing/code/core_team.rst index b787452c64a..daf1d1cb868 100644 --- a/contributing/code/core_team.rst +++ b/contributing/code/core_team.rst @@ -168,8 +168,28 @@ All code must be committed to the repository through pull requests, except for :ref:`minor change ` which can be committed directly to the repository. -**Mergers** must always use the command-line ``gh`` tool provided by the -**Project Leader** to merge the pull requests. +**Mergers** must always use the command-line ``gh`` tool to merge pull +requests. + +When merging a pull request, the tool asks for a category that should be chosen +following these rules: + +* **Feature**: For new features and deprecations; Pull requests must be merged + in the development branch. + +* **Bug**: Only for bug fixes; We are very conservative when it comes to + merging older, but still maintained, branches. Read the :doc:`maintenance` + document for more information. + +* **Minor**: For everything that does not change the code or when they don't + need to be listed in the CHANGELOG files: typos, Markdown files, test files, + new or missing translations, etc. + +* **Security**: It's the category used for security fixes and should never be + used except by the security team. + +Getting the right category is important as it is used by automated tools to +generate the CHANGELOG files when releasing new versions. Release Policy ~~~~~~~~~~~~~~