CONTRIBUTING.md

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:

• make
• Go 1.16+
• golangci-lint
• Docker (or Podman)
• kind
• pre-commit (optional)
• ngrok (optional)

Clone k8s-image-swapper anywhere:

git clone [email protected]: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

Test your change

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

make test

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

make fmt lint test

Which runs all the linters and tests.

Create a commit

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

You can follow the documentation on their website.

Submit a pull request

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