Skip to content

Commit cea4ceb

Browse files
Added instructions to CONTRIBUTING.md
1 parent 25b40b2 commit cea4ceb

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONTRIBUTING.md

+6
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,9 @@ To write and inspect unit tests:
5656
- MCAD and InstaScale unit tests under `mcad_controller_test.go` and `instascale_controller_test.go` in the `controllers` dir
5757
- Unit test functions are defined in `suite_test.go` (with utils in `util/util.go`) in the `controllers dir`
5858
- Test cases defined under `controllers/testdata`
59+
60+
## Local debugging with VSCode
61+
Steps outlining how to run the operator locally.
62+
- Populate the `.vscode/launch.json` file with the location of your Kubernetes config file and desired namespace.
63+
- In VSCode on the activity bar click `Run and Debug` or `CTRL + SHIFT + D` to start a local debugging session of the CodeFlare Operator.
64+
The operator should be running as intended.

0 commit comments

Comments
 (0)