From de8bffd244012cef15b9f608a86fce93c434150d Mon Sep 17 00:00:00 2001 From: Juliana Fajardini Date: Fri, 24 Nov 2023 08:29:06 -0300 Subject: [PATCH] devguide: doc from behavior changes needs ticket # If a commit introduces code that changes Suricata behavior, the related documentation changes should go in a separate commit, but refer to the same ticket number. This reduces the chances of said changes being lost if there are backports while still keeping the backporting process a bit less bulky, for each commit. Related to Task #6568 --- .../devguide/contributing/code-submission-process.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/userguide/devguide/contributing/code-submission-process.rst b/doc/userguide/devguide/contributing/code-submission-process.rst index 99ac93d5e2..e6a0f2fd33 100644 --- a/doc/userguide/devguide/contributing/code-submission-process.rst +++ b/doc/userguide/devguide/contributing/code-submission-process.rst @@ -9,9 +9,12 @@ Commits #. Commits need to be logically separated. Don't fix unrelated things in one commit. #. Don't add unnecessary commits, if commit 2 fixes commit 1 merge them together (squash) #. Commits need to have proper messages, explaining anything that is non-trivial -#. Commits should not, at the same time, change, rename and/or move code. Use separate commits - for each of this, e.g, a commit to rename files, then a commit to change the code. -#. Documentation updates should be in their own commit (not mixed with code commits) +#. Commits should not, at the same time, change, rename and/or move code. Use + separate commits for each of this, e.g, a commit to rename files, then a commit + to change the code. +#. If your code changes or adds new behavior, add the related documentation + updates in their own commit, but make sure to add the same ticket number to + both commit messages. #. Commit messages need to be properly formatted (check the example further below in this section): * Meaningful and short (50 chars max) subject line followed by an empty line