Development Environment

VS Code

If you want to contribute, you'd probably go with VS code, unless you already have some other Golang development that you are familiar with.

If you are going with VS Code, install the official Golang extension and you'll have the correct formatting, you'll have a debugger and much more.

Formatting

If you are not using VS Code, please either manually format your code with gofmt -w -s FILES or setup your IDE / editor to do so for you.

Tests

Before you commit anything or make a PR, please always run tests via go test ./....

Tools

The tools/ folder in the workspace contains things that aren't part of the application but can be used to aid in development one way or another. Feel free to add useful tools via PRs.

Playground

If you are just trying out some stuff, you probably don't want your experiments to show up in git status or your VS Code VCS view. For this, we've got the workspace folder playerground/, which is listed in .gitgnore.

For each new experiment, simply create a new subfolder with a main.go. This is necessary since there can only be one mainfile per folder (package).