]> git.puffer.fish Git - mirror/frr.git/commitdiff
doc: add doc for easy commit sign-off with `-s` 5471/head
authorStephen Worley <sworley@cumulusnetworks.com>
Wed, 4 Dec 2019 16:27:30 +0000 (11:27 -0500)
committerStephen Worley <sworley@cumulusnetworks.com>
Wed, 4 Dec 2019 16:27:30 +0000 (11:27 -0500)
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 <sworley@cumulusnetworks.com>
doc/developer/workflow.rst

index 6eef7532b3cc769d0c78250b587c69da91aec4a9..40378f02195c50661318a5ab8bf6ec0e84624cb2 100644 (file)
@@ -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 <developers-certificate-of-origin>`.