Document commit message syntax, job directives, etc. Decorate as a cross-reference page to encourage reuse
Change-Id: I3f3b12cfd6cd3dd10a91b28a36f4e487fa25f464
diff --git a/overview/contributing.rst b/overview/contributing.rst
index f774e18..4b892d8 100644
--- a/overview/contributing.rst
+++ b/overview/contributing.rst
@@ -51,15 +51,20 @@
* - Command
- Description
* - `make lint <https://docs.voltha.org/master/howto/code/linting.html>`_
- - Syntax check source for problems
+ - Syntax check source for problems (lint, lint-shelcheck, lint-doc8)
* - make sca
- Static Code Analysis
+ * - make build
+ - Assemble, compile, generate, link, ...
* - make test
- Invoke VOLTHA test suite(s)
* - make help
- - Show available targets, bulk source cleanup needed for `make lint` to check everything by default.
+ - Show available targets: make help | grep lint
- 4. Submitting your patch will initiate a `jenkins job <https://jenkins.opencord.org>`_ to validate changes.
+ 4. :ref:`Commit message syntax and testing directives <pull-request--commit-message>`
+
+ 5. Submitting your patch will initiate a validation
+ `jenkins job <https://jenkins.opencord.org>`_.
Wait for job completion status before proceeding.
- Job completion status will be sent to you asynchronously in email.
@@ -77,10 +82,10 @@
If failures persist `ask for assistance <https://wiki.opennetworking.org/display/COM/VOLTHA>`_ in slack or a mailing list.
- 5. When comments are made to your patch please make the appropriate fixes and then
+ 6. When comments are made to your patch please make the appropriate fixes and then
amend your commit with `git commit --amend` and re-upload to gerrit with `git review`.
- 6. Await review. Everyone can comment on code changes, but only Core contributors
+ 7. Await review. Everyone can comment on code changes, but only Core contributors
can give final review approval. **All changes must get at least one
approval**. Join one of the `communication channels <https://wiki.opennetworking.org/display/COM/VOLTHA>`_
to request a review or to bring additional attention to your patch.