You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documentation/source/contributing/contribute-code.rst
+6-12Lines changed: 6 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,25 +19,19 @@ Commit Naming Convention
19
19
20
20
The commit naming convention will be checked by our continuous integration. In order to be valid, the following rules must all be fulfilled:
21
21
22
-
- The commit message must begin with a category in square brackets which describes the code part that was changed
23
-
- The commit category must not be empty
24
-
- A commit category must contain at least two characters. Allowed characters are: letters ``a-z``, numbers ``0-9``, and ``-``. For example ``[gpu-texture]``
25
-
- If two code parts are affected, separate the categories using ``|``, for example ``[gpu-texture|gpu-info]``
26
-
- If three or more code parts are affected, use ``[*]`` as category
27
-
- Leave one space after the commit category
28
22
- The commit message itself must consist of the following characters: letters ``a-z``, numbers ``0-9``
29
23
- The commit message must begin with a capital letter
30
24
- The commit message must exist and it must not be empty
31
25
- The commit message must not end with ``.``, ``!`` or ``?``
32
26
33
27
**Examples**
34
28
35
-
- ``[docs] Explain commit naming convention``
36
-
- ``[gpu-info] Don't display empty gpu info queries as error``
37
-
- ``[gpu-info|representation] Cleanup``
38
-
- ``[ci] Add commit naming check``
39
-
- ``[*] Move GPU info to vk tools``
29
+
- ``Explain commit naming convention``
30
+
- ``Don't display empty gpu info queries as error``
31
+
- ``Cleanup octree vertices and indices``
32
+
- ``Add commit naming check``
33
+
- ``Move GPU info to vk tools``
40
34
41
35
**Additional Information**
42
36
43
-
The regex pattern for the commit category is ``\*|(?:[a-z0-9]{2,}[\s|-]?)+``, the pattern for the message is ``[A-Z0-9].+[^.!?,\s]``
37
+
The Regex pattern for the message is ``^[A-Z0-9]\S*(?:\s\S*)+[^.!?,\s]$``
0 commit comments