Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

56 lines (38 loc) · 1.29 KB
Raw

Contributing to gitkube

Thank you for your interest in developing gitkube. Refer to this guide to get started.

Pre-requisites

Following three tools are needed to get started:

  • Go 1.8+ (not required if building with docker)
  • Docker to build and push images.
  • Kubernetes cluster to test your build.

Fork the repo

Fork the repo and clone it locally to your GOPATH :

$ mkdir -p $GOPATH/src/github.com/hasura
$ cd $GOPATH/src/github.com/hasura
$ git clone [email protected]:<username>/gitkube.git
$ cd gitkube

For pulling changes from upstream, run this remote command:

$ git remote add upstream https://github.com/hasura/gitkube.git

Make changes, build and push

  • Make changes to the code.
  • Set IMAGE_REGISTRY environment variable to your docker hub or any other image registry (e.g. quay.io/<username> or just <docker-hub-username>)
$ export IMAGE_REGISTRY=<your-image-registry>
$ make build-all
$ make push-all

This will edit the image name in manifest/gitkube-setup.yaml with the built docker image.

Test

Run an end-to-end test to check if everything is working well. If your change adds a new feature, try to add it in the tests too.

$ cd e2e
$ ./test.bash

# teardown after the tests
$ ./teardown.bash

Send PR

If all looks well, send a PR!