X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;fp=docs%2Fdeveloper-guide.rst;h=85a3cfd0946fb08766ae10dfc6f98df32b12aa2a;hb=2407cdc0fd08abf96999473f172acbe23bc2af33;hp=0000000000000000000000000000000000000000;hpb=e2e3e435babf3aeb8c1bae14ad2a055d02bee38a;p=ric-plt%2Fxapp-frame-py.git

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
new file mode 100644
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 .