Skip to content

Commit

Permalink
Add information about PR merge commit category
Browse files Browse the repository at this point in the history
  • Loading branch information
fabpot committed Jan 13, 2025
1 parent a3f4885 commit 656d45f
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions contributing/code/core_team.rst
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,28 @@ All code must be committed to the repository through pull requests, except for
:ref:`minor change <core-team_minor-changes>` 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 `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, ...).

* **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 that
I'm using when releasing new versions.

Release Policy
~~~~~~~~~~~~~~
Expand Down

0 comments on commit 656d45f

Please sign in to comment.