sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc: Include commit log examples

Browse Source 
The Documentation was missing the commit log message examples

Signed-off-by: Alan C. Assis <acassis@gmail.com>
This commit is contained in:
Alan Carvalho de Assis 2024-07-23 20:05:11 -03:00 committed by Xiang Xiao
parent a83a569652
commit 42c9a829da
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
Documentation/contributing/making-changes.rst
View File

@ -206,6 +206,34 @@ squash before submitting the Pull Request:
Here's `GitHub's instructions for creating a Pull Request <https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request>`_.
It is important to include an informative commit title and a commit message.
In the commit title please include the subsystem/area related to your contribution,
followed by a descriptive message. Some examples:
.. code-block:: bash
boards/stm32f4discover: 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 <you@whoareyou.com>
Another example, submitting a commit to fix an issue in the fictional sensor xyz123:
.. code-block:: bash
sensors/xyz123: Fix a pressure conversion resolution issue
I found an issue in the XYZ123 sensor when converting the
pressure. The raw value should be divided by 4.25 instead
of 4.52.
Signed-off-by: Your Name <you@whoareyou.com>
You can search in the github commit history for more examples.
#. Get Pull Request feedback and implement changes
Get suggestions for improvements from reviewers, make changes, and push them to the branch. Once the reviewers are