From 25f601048040304331d8cf4419efc2d06c242211 Mon Sep 17 00:00:00 2001 From: Markus Frei Date: Wed, 13 Nov 2024 17:12:55 +0100 Subject: [PATCH] docs: Update CONTRIBUTING --- CONTRIBUTING.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 96d88d1e..1e1473e0 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -265,8 +265,9 @@ Lessons learned: When it comes to parameters, stay backwards compatible. If you Git Commits ----------- -* Commit messages must start with "plugin-name: " and clearly and precisely state what has changed. Example: ``about-me: Should be able to run even if psutil is or cannot be installed``. -* If there is an issue, the commit message must consist of the issue title followed by "(fix #issueno)", for example: ``about-me: Add OpenVPN (fix #341)``. +* | Since 2024-11-13, commit messages follow the `Conventional Commits specification `_ + | Example: ``fix(about-me): cryptography deprecation warning``. +* If there is an issue, the commit message must consist of the issue title followed by "(fix #issueno)", for example: ``fix(about-me): cryptography deprecation warning (fix #341)``. * For the first commit, use the message ``Add ``.