From aeb200e001f56982115bb8bc908a15a49373f9ec Mon Sep 17 00:00:00 2001 From: Juliana Fajardini Date: Wed, 29 May 2024 12:24:30 -0300 Subject: [PATCH] devguide: highlight commit message example Although we have the example for a commit message in our Code Submission Process sub-chapter, seems that people still oversee it a lot. It was suggested that we put it in a note-box, to make it more visible. --- .../contributing/code-submission-process.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/doc/userguide/devguide/contributing/code-submission-process.rst b/doc/userguide/devguide/contributing/code-submission-process.rst index e6a0f2fd33..05898ce319 100644 --- a/doc/userguide/devguide/contributing/code-submission-process.rst +++ b/doc/userguide/devguide/contributing/code-submission-process.rst @@ -32,15 +32,17 @@ Information that needs to be part of a commit (if applicable): #. Coverity Scan issues addressed. #. Static analyzer error it fixes (cppcheck/scan-build/etc) -When in doubt, check our git history for other messages or changes done to the -same module your're working on. This is a good example of a `commit message -`_:: +.. note:: - pcap/file: normalize file timestamps + When in doubt, check our git history for other messages or changes done to the + same module your're working on. This is a good example of a `commit message + `_:: - Normalize the timestamps that are too far in the past to epoch. + pcap/file: normalize file timestamps - Bug: #6240. + Normalize the timestamps that are too far in the past to epoch. + + Bug: #6240. .. _pull-requests-criteria: