This page describes what you need to install as a developer and contributor to this project, for setting up a development environment.
Linux and Mac OS operating systems are officially supported.
Windows users should consider using Windows Subsystem for Linux 2 (WSL 2), a remote Linux machine, or any other solution such as a virtual machine.
Install the following on your machine:
Then, run the following command to install additional dependencies:
This installs additional dependencies to
make targets (e.g.,
make test) are configured to use the binaries from
hack/tools/bin. However, you may want to add some of these tools to your system PATH for direct usage from your terminal (e.g., for using
NOTE: If you want to contribute to the documentation on the website, and preview the website locally, you should install Mkdocs-Material and follow a few more steps.
The project is predominantly written in Go, so we recommend Visual Studio Code for its good Go support. Alternatively you can select from Editors
Docker hub rate limits
As docker hub introduced rate limits on docker image downloads this may affect development using the local kind setup. One option to fix the limit is to use a docker hub login for downloading the images. The environment will run a docker registry as a proxy for all public images. This registry runs in a docker container next to the kind clusters.
export DOCKERHUB_USERNAME='your docker hub username' export DOCKERHUB_PASSWORD='your password'
Optional Code Improvement and Verification Tools
Fybrik repositories use different linters to validate and improve code.
golangci-lint works as a Go linters aggregator, which includes a lot of linter such as
goimports and more.
You can check its configuration in the
Integrating golangci-lint with VS Code
Change the default lint to
golanci-lint in VS Code:
- Install golangci-lint: https://golangci-lint.run/usage/install/
- Open VS Code
- Open the Command Palette:
- In the dropdown search box, search for "Open Settings (JSON)"
- Open the Command Palette:
- Add to
"go.lintTool":"golangci-lint", "go.lintFlags": [ "--fast", "--allow-parallel-runners" ]
Golangci-lint automatically discovers
.golangci.yml in the working project, you don't need to configure it in VS Code settings.
To integrate with other IDEs: https://golangci-lint.run/usage/integrations/
If you wish to run golangci-lint on cmd, run in the desired directory:
golangci-lint run --fast
pre-commit is an optional tool that inspect the snapshot that's about to be committed according to the configured hooks, in our case,
Pre-commit configuration is in
How to use:
- Install pre-commit: https://pre-commit.com/
- In the repository, run:
pre-commit will automatically validate all your commits.
To run commits without
pre-commit validation add the
--no-verify flag to