Updates in the contributing doc, add context and detail.
overview/contributing.rst
-------------------------
- Remove inative email addresses.
- Added links and detail in Steps to successful PRs
- Fixed a few document references that were literal or not resolving.
- Update ONF contacts for topics.
Change-Id: Id01c982bb82604575536ab7a341bdc6a7cf9580d
diff --git a/VERSION b/VERSION
index 35a5840..e249ffa 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.11.1-dev2
+2.12.0-dev1
diff --git a/bandwidth-profiles/bandwidth-profiles.rst b/bandwidth-profiles/bandwidth-profiles.rst
index 6fe7661..f4f72cc 100644
--- a/bandwidth-profiles/bandwidth-profiles.rst
+++ b/bandwidth-profiles/bandwidth-profiles.rst
@@ -1,5 +1,5 @@
Bandwidth Profiles in VOLTHA
-=============================================
+============================
This document describes Bandwidth profiles format in Sadis, how they are configured to VOLTHA and
how they are mapped to physical configuration for the OLT and the ONU with Traffic Descriptors
@@ -154,5 +154,3 @@
Please note that the values for the elements in the Traffic Descriptor ME are in Bytes/second so a conversion from the
kilobits/second of the Sadis representation is done by multiplying the values by 125 (kbps --> bps --> Bps).
-
-
diff --git a/mdl_strict.rb b/mdl_strict.rb
index 1f7944e..eff9158 100644
--- a/mdl_strict.rb
+++ b/mdl_strict.rb
@@ -34,4 +34,3 @@
# Numbered lists should have the correct order
rule 'MD029', :style => "ordered"
-
diff --git a/overview/contributing.rst b/overview/contributing.rst
index 019f1da..22f492a 100644
--- a/overview/contributing.rst
+++ b/overview/contributing.rst
@@ -1,4 +1,3 @@
-======================
Contributing to VOLTHA
======================
@@ -31,33 +30,57 @@
Some additional points for developers:
- - Submit your changes early and often. Input and
- corrections early in the process prevent huge changes later.
-
- - Please open a `jira ticket <https://jira.opencord.org/projects/VOL>`_ describing the issue/feature. During the patch please
- preface the commit message with `[VOL-<jira_number]` e.g. `[VOL-4550]` so it gets
- automatically linked to the Jira ticket. This keeps code review and design discussions clean.
+ - 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.
Steps to successful PRs
+++++++++++++++++++++++
- 1. Checkout the code and prepare your patch. The workflow to make changes to the VOLTHA code through gerrit is identical
- to the one from `onos-classic` and is described in the
- `Sample Gerrit Workflow page <https://wiki.onosproject.org/display/ONOS/Sample+Gerrit+Workflow>`_
+ 1. Checkout the code base and prepare your patch.
+ 2. Workflow to modify VOLTHA code through gerrit is identical to `onos-classic`
+ and is described in `Sample Gerrit Workflow page <https://wiki.onosproject.org/display/ONOS/Sample+Gerrit+Workflow>`_
+ 3. Before submitting your patch via `git review` please pre-screen your changes to ensure code quality.
- 2. Before submitting the patch via `git review` please execute VOLTHA specific tests:
- `make test` and `make sca`. These commands run unit test, linting and other elements
- to assure the quality of your patch.
+ .. list-table:: Patch Pre-Screening
+ :widths: 10, 40
- 3. Wait for sanity checks `jenkins <https://jenkins.opencord.org>`_ to pass.
- If the tests fail please fix your patch with step 3 an then repeat 2 and 3, as necessary.
- **Passing CI verification is mandatory.** If the CI check does not start or fails but you think the issue
- is un-related you can re-trigger by commenting on to the patch with `recheck`.
+ * - Command
+ - Description
+ * - `make lint <https://docs.voltha.org/master/howto/code/linting.html>`_
+ - Syntax check source for problems
+ * - make sca
+ - Static Code Analysis
+ * - make test
+ - Invoke VOLTHA test suite(s)
+ * - make help
+ - Show available targets, bulk source cleanup needed for `make lint` to check everything by default.
- 4. When comments are made to your patch please make the appropriate fixes and then
+ 4. Submitting your patch will initiate a `jenkins job <https://jenkins.opencord.org>`_ to validate changes.
+ Wait for job completion status before proceeding.
+
+ - Job completion status will be sent to you asynchronously in email.
+ - For direct monitoring `review comment history for your patch <https://gerrit.opencord.org/q/status:open+-is:wip>`_.
+ - Search for `Jenkins Technical User <https://gerrit.opencord.org/c/voltha-docs/+/33952>`_ and click a job entry.
+ - In the top grey navigation bar, following "Dashboard", click the test suite name to view the active job dashboard history `verify_voltha-docs_unit-test <https://jenkins.opencord.org/job/verify_voltha-docs_unit-test/>`_.
+
+ If testing fails please fix your patch with step 3 an then repeat 2 and 3, as necessary.
+
+ **Passing CI verification is mandatory.**
+
+ If the CI check does not start or fails and you believe the issue is
+ un-related to a changeset you can re-trigger by commenting on the
+ patch with `recheck`.
+
+ 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
amend your commit with `git commit --amend` and re-upload to gerrit with `git review`.
- 5. Await review. Everyone can comment on code changes, but only Core contributors
+ 6. 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.
@@ -180,6 +203,7 @@
- `Thiyagarajan Subramani <Thiyagarajan.Subramani@radisys.com>`_
- `Burak Gurdag <burak.gurdag@netsia.com>`_
+ - `Girish Gowdra <girish.gowdra@intel.com>`_
ONOS apps:
@@ -191,15 +215,20 @@
- `Abhilash Satish Laxmeshwar <abhilash.laxmeshwar@radisys.com>`_
- `Gamze Abaka <gamze.abaka@netsia.com>`_
+ - `Girish Gowdra <girish.gowdra@intel.com>`_
+
+Build system, makefiles, reviews:
+
+ - `Joey Armstrong <joey@opennetworking.org>`_
+ - `David Ferguson <daf@opennetworking.org>`_
All of the codebase:
- - `Andrea Campanella <andrea@opennetworking.org>`_
- - `Matteo Scandolo <teo@opennetworking.org>`_
- - `Girish Gowdra <girish@opennetworking.org>`_
- - `Hardik Windlass <hardik@opennetworking.org>`_
- - `Suchitra Vemuri <suchitra@opennetworking.org>`_
- - `Saurav Das <saurav.das@opennetworking.org>`_
+ - `Andrea Campanella`
+ - `Matteo Scandolo`
+ - `Hardik Windlass`
+ - `Suchitra Vemuri`
+ - `Saurav Das`
- `Mahir Gunyel <mahir.gunyel@netsia.com>`_
- `Serkant Uluderya <serkant.uluderya@netsia.com>`_
- `Amit Ghosh <Amit.Ghosh@radisys.com>`_
@@ -211,4 +240,4 @@
This project follows `Google's Open Source Community Guidelines <https://opensource.google/conduct/>`_
-and ONF's [Code of Conduct](CODE_OF_CONDUCT.md).
+and ONF's `Code of Conduct <https://opennetworking.org/wp-content/themes/onf/img/onf-code-of-conduct.pdf>`_.
diff --git a/overview/release_process.rst b/overview/release_process.rst
index 45686eb..bee4a49 100644
--- a/overview/release_process.rst
+++ b/overview/release_process.rst
@@ -91,7 +91,7 @@
an artifact into the staging repo on `sonatype <https://oss.sonatype.org>`_. From there the artifact will need
to be released into maven central.
- - Login on sonatype (for username and password contact michelle@opennetworking.org)
+ - Login into the sonatype server (for username and password contact michelle@opennetworking.org)
- search for org.opencord
- Select the app you want to release and click "all versions"
- Click on "Staging repositories" (in the left side navigation)
@@ -108,10 +108,10 @@
- Modify pom.xml and dependencies.xml
- Update version string for all released dependencies.
-7. Start over with new app
+7. Start over with the next app
.. note::
- Given their inter dependency the ONOS apps need to be released in order:
+ Given component inter dependencies, ONOS apps need to be released in order:
1. sadis
2. olt, aaa, dhcpl2relay, mcast, igmpproxy, maclearning
@@ -133,8 +133,6 @@
- `Sadis <https://github.com/opencord/sadis>`_
-
-
Creating the release
--------------------
diff --git a/overview/releases.rst b/overview/releases.rst
index 1e070ed..4c86205 100644
--- a/overview/releases.rst
+++ b/overview/releases.rst
@@ -126,4 +126,3 @@
- December 30, 2022
-
-
-
diff --git a/release_notes/release_process.rst b/release_notes/release_process.rst
index 2953b6c..cbdfff5 100644
--- a/release_notes/release_process.rst
+++ b/release_notes/release_process.rst
@@ -172,4 +172,3 @@
- voltha-openolt-adapter
- voltha-openonu-adapter-go
- voltha-onos (includes ONOS Apps)
-