Skip to content

Commit

Permalink
devguide: highlight commit message example
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
jufajardini authored and victorjulien committed May 29, 2024
1 parent 41b9836 commit aeb200e
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions doc/userguide/devguide/contributing/code-submission-process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://github.com/OISF/suricata/commit/33fca4d4db112b75ffa22eb2e6f14f038cbcc1f9>`_::
.. 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
<https://github.com/OISF/suricata/commit/33fca4d4db112b75ffa22eb2e6f14f038cbcc1f9>`_::

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:

Expand Down

0 comments on commit aeb200e

Please sign in to comment.