Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

60 lines (43 loc) · 1.29 KB
Raw

Contributing

Report a Bug

Open an issue. Please include descriptions of the following:

  • Observations
  • Expectations
  • Steps to reproduce

Contribute a Bug Fix

  • Report the bug first
  • Create a pull request for the fix

Suggest a New Feature

  • Create a new issue to start a discussion around new topic. Label the issue as new-feature

Setup your DEV environment

Argo Events is native to Kubernetes so you'll need a running Kubernetes cluster. This guide includes steps for Minikube for local development, but if you have another cluster you can ignore the Minikube specific step 3.

Requirements

  • Golang 1.13
  • Docker

Installation & Setup

1. Get the project

go get github.com/argoproj/argo-events
cd $GOPATH/src/github.com/argoproj/argo-events

2. Vendor dependencies

GO111MODULE=on go get github.com/cloudevents/sdk-go

3. Start Minikube and point Docker Client to Minikube's Docker Daemon

minikube start
eval $(minikube docker-env)

5. Build the project

make build

Follow README to install components.

Changing Types

If you're making a change to the pkg/apis package, please ensure you re-run:

make codegen

Test Policy

Changes without either unit or e2e tests are unlikely to be accepted.