Skip to content

Latest commit

 

History

History
66 lines (38 loc) · 4.84 KB

CONTRIBUTING.md

File metadata and controls

66 lines (38 loc) · 4.84 KB
Raw

Contributing to Kubefirst

Firstly, we want to thank you for investing your valuable time to contribute to Kubefirst!

⚠️ Please note that this file is a work-in-progress, so more details will be added in the future.

Note we have a code of conduct which needs to be followed in all your interactions with the project to keep our community healthy.

Ways to Contribute

At Kubefirst, we believe that every contribution is valuable, not just the code one, which means we welcome

Before making a code change, first discuss your idea via an issue. Please check if a feature request or bug report does already exist before creating a new one.

Getting Started with the Code

Dev containers

A .devcontainer configuration is provided to allow for a full-featured development environment.

Local development

The CLI

Kubefirst is created using the Go Programming Language. To set up your computer, follow these steps.

Once Go is installed, you can run Kubefirst from any branch using go run .. Go will automatically install the needed modules listed in the go.mod file. Since Go is a compiled programming language, every time you use the run command, Go will compile the code before running it. If you want to save time, you can compile your code using go build, which will generate a file named kubefirst. You will then be able to run your compiled version with the ./kubefirst command.

If you want to create a Civo cluster, the command would be go run . civo create.

GitOps Template

Note that even if you run kubefirst from main, the gitops-template version used will be the latest release. If you also want to use the latest from main for the template, you need to run to use the --gitops-template-url, and the --gitops-template-branch as follow:

go run . civo create --gitops-template-url https://github.com/konstructio/gitops-template --gitops-template-branch main

Kubefirst API

If you need to use a specific branch or latest from main that wasn't released yet for the kubefirst-api repository, you will need to first run it locally as described in its documentation. You will also need to run the code from console repository, whether you need to use a specific version of the code or not, as we don't expose the API directly. To do so, follow the instructions in its README. Before running the CLI as mentionned "The CLI" section, you need to export a local variable:

export K1_CONSOLE_REMOTE_URL="http://localhost:3000"

The previous steps will work for all clouds except k3d which use our runtime for now: we have plan to remove this dependencies completely and use the API also to make the code easier to maintain, and less prone to issues. For that step, instead of running the API, and console locally, you simply need to clone the kubefirst-api repository locally, and add the following line in the go.mod file:

github.com/konstructio/kubefirst-api vX.X.XX => /path-to/kubefirst-api/

Replace vX.X.XX with the latest version used in the mode file for the API, and the /path-to/kubefirst-api/ with the path to the folder of your locally Kubefirst API folder.

Getting Started with the Documentation

Please check the CONTRIBUTING.md file from the docs repository.

Help

If you need help in your Kubefirst journey as a contributor, please join our Slack Community. We have the #contributors channel where you can ask any questions or get help with anything contribution-related. For support as a user, please ask in the #helping-hands channel, or directly to @fharper (Fred in Slack), our Developer Advocate.