sendnrw/netbird
2
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-05-03 15:46:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(contribution.md) project setup

Browse Source
This commit is contained in:
shatoboar
2022-06-22 17:21:36 +02:00
parent f31f8a76fb
commit 2c2790603e
1 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/contribution.md
View File

@@ -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: