Upgrade to RMR version 4.0.2

[ric-plt/xapp-frame-py.git] / docs / developer-guide.rst

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
new file mode 100644 (file)
index 0000000..85a3cfd
--- /dev/null
+++ b/docs/developer-guide.rst
@@ -0,0 +1,37 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Developer Guide
+===============
+
+.. contents::
+   :depth: 3
+   :local:
+
+Version bumping the framework
+-----------------------------
+
+This project follows semver. When changes are made, the versions are in:
+
+1) ``docs/release-notes.rst``
+
+2) ``setup.py``
+
+Version bumping RMR
+-------------------
+
+These items in this repo must be kept in sync:
+* Dockerfile-Unit-Test
+* examples/Dockerfile-Ping
+* examples/Dockerfile-Pong
+* ``rmr-version.yaml`` controls what rmr gets installed for unit testing in Jenkins
+
+
+Unit Testing
+------------
+
+You can run the unit tests in Docker to avoid installing RMR locally:
+
+::
+
+   docker build -f Dockerfile-Unit-Test .