Table of Contents

Overview

This page provides guidance to those wanting to contribute to the project.

There is also a readme.md file at the top level that guides common activities.

The application components run in kubernetes. As a result, they must be packaged as images that can be picked up by the deployment specs.

Local development works differently for this than for production uat and production releases.

The flow of activities is something like this:

Development Flow

pull or clone the repo
create a new branch
make the necessary changes
test locally
- test out of that directory following directions in the local readme.md file
- write and run tests using chai
- build the docker image
- update the helm chart to point to temporary image location
test with local reference implementation
- follow instructions for the reference impl in the root readme.md file
deploy to cloud ?? how to do this?
pull request for production ?? how to do this?
distribute to distributed nodes ?? how to do this?

First pull or fork the latest from the develop branch.

Make a branch of for your changes.

Each subdirectory has a readme.md file that helps with the details of local development.