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
+++++++++++++++++++++++
diff --git a/overview/contributing/code_review.rst b/overview/contributing/code_review.rst
new file mode 100644
index 0000000..3727a53
--- /dev/null
+++ b/overview/contributing/code_review.rst
@@ -0,0 +1,12 @@
+Request a code review
+=====================
+
+- `Code Reviews <https://docs.voltha.org/master/howto/code/pull_request.html#development-and-code-reviews>`_
+- :doc:`Code review request <../../howto/code/pull_request>` (:doc: token syntax problem)
+
+See Also
+--------
+
+- `Development resources <https://docs.voltha.org/master/howto/code/index.html>`_
+- `Commit message syntax <https://docs.voltha.org/master/howto/code/commit-message.html>`_
+
diff --git a/overview/contributing/copyright.rst b/overview/contributing/copyright.rst
new file mode 100644
index 0000000..ba3f77a
--- /dev/null
+++ b/overview/contributing/copyright.rst
@@ -0,0 +1,17 @@
+Copyright Notice
+================
+
+Include a copyright notice with all submissions to ONF repositoreis.
+
+- ``Copyright 2017-2023 Open Networking Foundation (ONF) and the ONF Contributors``
+- NOTE: Range values such as -present are not legally binding
+
+ - Copyright notice should be dated to the last year sources were modified.
+
+See Also
+--------
+
+- `Copyright notices <https://github.com/joey-onf/copyright>`_
+- `Message syntax <https://github.com/joey-onf/copyright/blob/origin/master/notice>`_
+- `ONF CLA Information <https://wiki.opennetworking.org/display/COM/ONF+CLA+Information>`_
+- `Contributing License Agreement Manager <https://cla.opennetworking.org/>`_
diff --git a/overview/contributing/jira_tickets.rst b/overview/contributing/jira_tickets.rst
new file mode 100644
index 0000000..d7fd3d9
--- /dev/null
+++ b/overview/contributing/jira_tickets.rst
@@ -0,0 +1,33 @@
+Jira tickets for code changes
+=============================
+
+Please open a `jira ticket <https://jira.opencord.org/projects/VOL>`_ describing the issue/feature.
+
+- For large or multi-part features create a containing ticket with several
+ sub-tickets tracking individual features or problems.
+- Descripton - include relevant information
+
+ - Error messages
+ - Reproduction step(s) for problems
+ - Web URLs, links to jenkins job logs are very helpful.
+
+ - Note: Jenkins job logs will age out and disappear over time.
+ - To prevent this view the job history panel in jenkins UI
+
+ - Two links are available in history, colored icon on the left and #job on the right.
+ - Click the #job link to view job.
+ - Top right corner will contain a clickable button "Keep this build forever".
+ - Just remember to clear this attribute after the jira ticket is closed.
+
+- Assign field ``Fix Version/s:`` VOLTHA-X.Y
+
+ - This will enables searching for feature by release.
+ - Leveraged during release to document fixes and enhancements in release notes.
+- While viewing a jira ticket, the 'More' navigation pulldown menu at the top
+ is useful for creating sub tickets or creating links to external resources.
+
+See Also
+--------
+
+- https://jira.opencord.org
+- `jira :: VOLTHA <https://jira.opencord.org/projects/VOL/issues/VOL-4470?filter=allopenissuse>`_