Skip to content

Commit

Permalink
doc: add steps to build and deploy locally to contributing guide (#463)
Browse files Browse the repository at this point in the history
- Updated the Contributing guide with detailed instructions for building
  and deploying the project locally.
- Steps include creating a local kind cluster, building the container,
  and loading it into the cluster.

This addition helps contributors set up their local environment efficiently.
  • Loading branch information
camilamacedo86 authored Nov 18, 2024
1 parent dd64145 commit e3c877c
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,29 @@ details.
- Create a new branch from the default `main` branch and begin development in
the area of your interest.

## How to Build and Deploy Locally

After creating a fork and cloning the project locally,
you can follow the steps below to test your changes:

1. Create the cluster:

```sh
kind create cluster -n catalogd
```

2. Build your changes:

```sh
make build-container
```

3. Load the image locally and Deploy to Kind

```sh
make kind-load deploy
```

## Reporting bugs and creating issues

Any new contribution should be linked to a new or existing github issue in the
Expand Down

0 comments on commit e3c877c

Please sign in to comment.