Skip to content

Commit e3c877c

Browse files
doc: add steps to build and deploy locally to contributing guide (operator-framework#463)
- 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.
1 parent dd64145 commit e3c877c

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,29 @@ details.
3535
- Create a new branch from the default `main` branch and begin development in
3636
the area of your interest.
3737

38+
## How to Build and Deploy Locally
39+
40+
After creating a fork and cloning the project locally,
41+
you can follow the steps below to test your changes:
42+
43+
1. Create the cluster:
44+
45+
```sh
46+
kind create cluster -n catalogd
47+
```
48+
49+
2. Build your changes:
50+
51+
```sh
52+
make build-container
53+
```
54+
55+
3. Load the image locally and Deploy to Kind
56+
57+
```sh
58+
make kind-load deploy
59+
```
60+
3861
## Reporting bugs and creating issues
3962

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

0 commit comments

Comments
 (0)