Firstly, we want to thank you for investing your valuable time to contribute to Kubefirst!
Note we have a code of conduct which needs to be followed in all your interactions with the project to keep our community healthy.
At Kubefirst, we believe that every contribution is valuable, not just the code one, which means we welcome
- bug reports;
- feature requests;
- documentations issues reports like unclear section, missing information or even typos;
- and, of course, any code contributions to Kubefirst, or the documentations.
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.
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. As an example, if you want to create a local cluster, the command would be go run . local.
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 need help in your Kubefirst journey as a contributor, please join our Slack Community. We have the #kubefirst-oss 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.