@@ -50,6 +50,16 @@ Code
5050====
5151
5252.. _PEP8: https://www.python.org/dev/peps/pep-0008/
53+.. _Conventional Commits: https://www.conventionalcommits.org/
54+.. _Git Commit Good Practice: https://wiki.openstack.org/wiki/GitCommitMessages
55+.. _Structural split of changes:
56+ https://wiki.openstack.org/wiki/GitCommitMessages#Structural_split_of_changes
57+
58+.. sidebar:: Create good commits!
59+
60+ - `Structural split of changes`_
61+ - `Conventional Commits`_
62+ - `Git Commit Good Practice`_
5363
5464
5565In order to submit a patch, please follow the steps below:
@@ -59,6 +69,9 @@ In order to submit a patch, please follow the steps below:
5969 - PEP8_ standards apply, except the convention of line length
6070 - Maximum line length is 120 characters
6171
72+- The cardinal rule for creating good commits is to ensure there is only one
73+ *logical change* per commit / read `Structural split of changes`_
74+
6275- Check if your code breaks existing tests. If so, update the tests or fix your
6376 code.
6477
@@ -66,6 +79,16 @@ In order to submit a patch, please follow the steps below:
6679
6780- Add yourself to the :origin:`AUTHORS.rst` file.
6881
82+- Choose meaning full commit messages, read `Conventional Commits`_
83+
84+ .. code::
85+
86+ <type>[optional scope]: <description>
87+
88+ [optional body]
89+
90+ [optional footer(s)]
91+
6992- Create a pull request.
7093
7194For more help on getting started with searx development, see :ref:`devquickstart`.