From 2c2790603ea9261e2e93feff77786d30fd93a707 Mon Sep 17 00:00:00 2001 From: shatoboar Date: Wed, 22 Jun 2022 17:21:36 +0200 Subject: [PATCH] feat(contribution.md) project setup --- docs/contribution.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/contribution.md b/docs/contribution.md index 34d2e1da8..15ec77cd2 100644 --- a/docs/contribution.md +++ b/docs/contribution.md @@ -1,5 +1,28 @@ # Contribution +### To start developing Netbird +**You have a working Go environment** + +Clone the project into your preferred path. We recommend just cloning into the GOPATH. +``` +mkdir -p $GOPATH/src/github.com/netbirdio +cd $GOPATH/src/github.com/netbirdio +git clone git@github.com:netbirdio/netbird.git +cd netbird +go build ./... +``` +**_Sidenote_** _`libayatana-appindicator3-dev` might be needed for developing on debian based distros._ + + +**To run the tests execute:** + +``` +go test -exec sudo ./... +``` +The tests need to be executed by a superuser, +because to run the integration tests we need to create network interfaces. + + ### Code Structure The codebase is structured in 3 big components: