Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 2423666

Browse filesBrowse files
committed
Add information about PR merge commit category
1 parent a3f4885 commit 2423666
Copy full SHA for 2423666

File tree

Expand file treeCollapse file tree

1 file changed

+22
-2
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+22
-2
lines changed

‎contributing/code/core_team.rst

Copy file name to clipboardExpand all lines: contributing/code/core_team.rst
+22-2Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,8 +168,28 @@ All code must be committed to the repository through pull requests, except for
168168
:ref:`minor change <core-team_minor-changes>` which can be committed directly
169169
to the repository.
170170

171-
**Mergers** must always use the command-line ``gh`` tool provided by the
172-
**Project Leader** to merge the pull requests.
171+
**Mergers** must always use the command-line ``gh`` tool to merge pull
172+
requests.
173+
174+
When merging a pull request, the tool asks for a category that should be chosen
175+
following these rules:
176+
177+
* **Feature**: For new features and deprecations; Pull requests must be merged
178+
in the development branch.
179+
180+
* **Bug**: Only for bug fixes; We are very conservative when it comes to
181+
merging older, but still maintained, branches. Read the :doc:`maintenance`
182+
document for more information.
183+
184+
* **Minor**: For everything that does not change the code or when they don't
185+
need to be listed in the CHANGELOG files: typos, Markdown files, test files,
186+
new or missing translations, etc.
187+
188+
* **Security**: It's the category used for security fixes and should never be
189+
used except by the security team.
190+
191+
Getting the right category is important as it is used by automated tools to
192+
generate the CHANGELOG files when releasing new versions.
173193

174194
Release Policy
175195
~~~~~~~~~~~~~~

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.