From 742000af2043ab2f9b18f5a062491fe1ab66573e Mon Sep 17 00:00:00 2001 From: John DeNisco Date: Mon, 6 Jul 2020 12:27:58 -0400 Subject: docs: Reflect the fact that the DPDK is now a plugin Type: Improvement Signed-off-by: John DeNisco Change-Id: Ic1253f601ee515392902a21b92e1dfd3962cc0a4 --- docs/gettingstarted/developers/gitreview.rst | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) (limited to 'docs/gettingstarted/developers') diff --git a/docs/gettingstarted/developers/gitreview.rst b/docs/gettingstarted/developers/gitreview.rst index a962d25e4fd..3f865c159a2 100644 --- a/docs/gettingstarted/developers/gitreview.rst +++ b/docs/gettingstarted/developers/gitreview.rst @@ -83,7 +83,22 @@ For example for a document with only patches you should add the tag **docs:**. .. code-block:: console $ git add - $ git commit -s -m "<*TAG*>: <*COMMIT_MESSAGE*>" + $ git commit -s + +The commit comment should have something like the following comment: + +.. code-block:: console + + docs: A brief description of the commit + + Type: Improvement (The type of commit this could be: Improvement, Fix or Feature) + + A detailed description of the commit could go here. + +Push the patch for review. + +.. code-block:: console + $ git review If you are creating a draft, meaning you do not want your changes reviewed yet, do the following: -- cgit 1.2.3-korg