CONTRIBUTING.md

kaos Contribution Guidelines

Contributions are welcome, and they are greatly appreciated!

Please follow the kaos Contributor Code of Conduct for all your interactions.

Types of Contributions

Please note that an issue is required for all kaos contributions. The following is a list of the different types of contributions:

• To help keep kaos running smoothly

  • Report Bugs
  • Fix Bugs

• To help improve existing kaos functionality

  • Change Request
  • Implement Changes

• To help increase kaos functionality

  • Feature Request
  • Implement Features

Development Environment

kaos consists of an easy-to-use user interface, a multi-environment machine learning backend and a cloud agnostic infrastructure.

Prerequisites

kaos is rather lightweight but requires the following (and on your PATH):

• pipenv
• docker
• Terraform
• Graphviz (Contains dot)

Installation

The recommended development installation of kaos is done automatically within a virtual environment using pipenv. Note that the --dev option is required for installing the backend and integration tests.

$ git clone https://github.com/KI-labs/kaos.git
$ pipenv install --dev && pipenv shell

If a new dependency is added to the setup, then the existing pipenv can be updated by simply running

$ pipenv update

A successful installation will yield the following when inspecting all requirements within pipenv.

$ pipenv graph

kaos==1.0.0
  - ...
  - kaos-model [required: ==1.0.0, installed: 1.0.0]
  - ...
kaos-backend==1.0.0
  - ...
kaos-integration-tests==1.0.0
  - ...

Further Information

Additional information is described independently for each layer in kaos.

• user interface
• backend
• infrastructure