From 118cf7edb020cb56588cc62052089faf0cc15969 Mon Sep 17 00:00:00 2001 From: Stephen Worley Date: Wed, 4 Dec 2019 11:27:30 -0500 Subject: [PATCH] doc: add doc for easy commit sign-off with `-s` Add some doc to let developers know about the `-s` flag with `git commit`. We were seeing some people writing the sign-off manually. Signed-off-by: Stephen Worley --- doc/developer/workflow.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index 6eef7532b3..40378f0219 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -293,6 +293,11 @@ Code submitted to FRR must be signed off. We have the same requirements for using the signed-off-by process as the Linux kernel. In short, you must include a ``Signed-off-by`` tag in every patch. +An easy way to do this is to use ``git commit -s`` where ``-s`` will automatically +append a signed-off line to the end of your commit message. Also, if you commit +and forgot to add the line you can use ``git commit --amend -s`` to add the +signed-off line to the last commit. + ``Signed-off-by`` is a developer's certification that they have the right to submit the patch for inclusion into the project. It is an agreement to the :ref:`Developer's Certificate of Origin `. -- 2.39.5