Contributing

By participating to this project, you agree to abide our code of conduct.

Setup your machine

k8s-image-swapper is written in Go.

Prerequisites:

Clone k8s-image-swapper anywhere:

git clone git@github.com:estahn/k8s-image-swapper.git

Install the build and lint dependencies:

make setup

A good way of making sure everything is all right is running the test suite:

make test

You can create a branch for your changes and try to build from the source as you go:

make build

When you are satisfied with the changes, we suggest you run:

make ci

Which runs all the linters and tests.

Commit messages should be well formatted, and to make that "standardized", we are using Conventional Commits.

You can follow the documentation on their website.

Push your branch to your k8s-image-swapper fork and open a pull request against the main branch.