Enhance Submitting Code section
overview/contributing.rst
overview/contributing/code_review.rst
overview/contributing/copyright.rst
overview/contributing/jira_tickets.rst
howto/code/commit-message.rst
howto/code/pull_request.rst
--------------------------------------
- Document a few items that surfaced in code reviews this morning.
- Add more links to existing documentation.
howto/release/repositories/pod-configs/
howto/release/repositories/voltha-onos/release.rst
howto/release/repositories/voltha-onos/todo.rst
--------------------------------------------------
- Create skeleton directories for documenting release items needed.
- Submitted as part of an earlier patch but included here for good measure.
Change-Id: Ibe118570bdf19ced1d06d6e9efb10fd1419f82ef
diff --git a/overview/contributing.rst b/overview/contributing.rst
index 4b892d8..768b878 100644
--- a/overview/contributing.rst
+++ b/overview/contributing.rst
@@ -30,12 +30,19 @@
Some additional points for developers:
- - Submit your changes early and often. Code and design review input
- with corrections early in the process prevent huge changes later.
- - Please open a `jira ticket <https://jira.opencord.org/projects/VOL>`_ describing the issue/feature.
- - While checking in changes please preface the commit message with
- `[VOL-<jira_number]` e.g. `[VOL-4550]` to automatically link changesets,
- jenkins jobs, etc making them self-documenting for discussions.
+- Submit your changes early and often. Code and design review input
+ with corrections early in the process prevent huge changes later.
+- :doc:`Create a Jira ticket for code changes <contributing/jira_tickets>` (required)
+- :doc:`Update copyright notices <contributing/copyright>`
+- `Commit message <https://docs.voltha.org/master/howto/code/commit-message.html#pull-request-commit-message>`_ and jenkins automation.
+
+ - To enable automation, prefix your commit message with a jira ticket
+
+ - ``[VOL-4550]`` - Spiffy enhancement/feature/problem summary
+
+ - This addition will allow jenkins to magically update tickets
+ with processed job status.
+- :doc:`Request a code review <contributing/code_review>`
Steps to successful PRs
+++++++++++++++++++++++