Skip to content

Latest commit

 

History

History
48 lines (44 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

48 lines (44 loc) · 1.07 KB

Contributing

Guidelines for contributors:

  • Contribute to the repository by creating a pull request.
  • Make suggestions for improvement by creating an issue.
  • Be nice.

Development Environment Setup

Development setup for contributors:

  1. Resolve submodules after cloning
git submodule update --init --recursive
  1. Fill env file with secrets
cp env .env
nano .env # use your favourite editor
  1. Run the stack
# use docker-compose OR
docker-compose up 
# use kubernetes. you need to have a kubernetes cluster
# already up and running.
helm install k8s-cms chart

Project Structure

  • project changelog - updated on new releases: CHANGELOG.md
  • dockerfiles used to build the images: containers/
  • Kubernetes manifests/helm chart: chart/
  • kcmscli source code: src/kcmscli/
  • End to end tests: test/

Project Makefile

The Project Makefile makes building & pushing the docker images easier:

  • build specific docker image
make <docker image name>
  • build all the docker images
make
  • push all the docker images
make push