git.iko.soy/searx
on master help sign in
doc(dev): add remarks about creating good commits (messages)
4ca8b69Markus Heiser
docs/dev/contribution_guide.rst+23
compare with master
unifiedsplit
@@ -50,6 +50,16 @@ Code
50====
50====
51
51
52.. _PEP8: https://www.python.org/dev/peps/pep-0008/
52.. _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`_
53
63
54
64
55In order to submit a patch, please follow the steps below:
65In 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:
59 - PEP8_ standards apply, except the convention of line length
69 - PEP8_ standards apply, except the convention of line length
60 - Maximum line length is 120 characters
70 - Maximum line length is 120 characters
61
71
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+
62- Check if your code breaks existing tests. If so, update the tests or fix your
75- Check if your code breaks existing tests. If so, update the tests or fix your
63 code.
76 code.
64
77
@@ -66,6 +79,16 @@ In order to submit a patch, please follow the steps below:
66
79
67- Add yourself to the :origin:`AUTHORS.rst` file.
80- Add yourself to the :origin:`AUTHORS.rst` file.
68
81
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+
69- Create a pull request.
92- Create a pull request.
70
93
71For more help on getting started with searx development, see :ref:`devquickstart`.
94For more help on getting started with searx development, see :ref:`devquickstart`.