aboutsummaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted
diff options
context:
space:
mode:
Diffstat (limited to 'docs/gettingstarted')
-rw-r--r--docs/gettingstarted/developers/gitreview.rst17
1 files changed, 16 insertions, 1 deletions
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 <filename>
- $ 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: