-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
The Documentation was missing the commit log message examples Signed-off-by: Alan C. Assis <[email protected]>
- Loading branch information
1 parent
a83a569
commit 42c9a82
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 <[email protected]> | ||
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 <[email protected]> | ||
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 | ||
|