doc: improve commit log examples

The releasenotes tools can use proper commit titles and automate commit sorting Signed-off-by: Alin Jerpelea <[email protected]>
apache · Jul 24, 2024 · 7c2462b · 7c2462b
1 parent 049a6da
commit 7c2462b
Showing 1 changed file with 15 additions and 2 deletions.
diff --git a/Documentation/contributing/making-changes.rst b/Documentation/contributing/making-changes.rst
@@ -211,15 +211,28 @@ squash before submitting the Pull Request:
    In the commit title please include the subsystem/area related to your contribution,
    followed by a descriptive message. Some examples:
 
+    Adding or fixing a platform
+
+    .. code-block:: bash
+
+       arch/<arch>/<platform>/: Add arch support for xxxxx platform
+
+       This patch adds initial support for xxxx platform. Please read
+       the documentation included for more details how to wire the display.
+
+       Signed-off-by: Your Name <[email protected]>
+
+    Adding or fixing a board
+
     .. code-block:: bash
 
-       boards/stm32f4discover: Add board initialization for SSD1306 OLED Display
+       boards/<arch>/<platform>/<board>: Add board initialization for SSD1306 OLED Display
 
        This patch adds support to use the display SSD1306 on I2C1, please read
        the documentation included for more details how to wire the display.
 
        Signed-off-by: Your Name <[email protected]>
-      
+
    Another example, submitting a commit to fix an issue in the fictional sensor xyz123:
 
     .. code-block:: bash