Skip to content

Commit

Permalink
Added instructions to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Bobbins228 committed Nov 1, 2023
1 parent df5f747 commit ea6c4ba
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,9 @@ To write and inspect unit tests:
- MCAD and InstaScale unit tests under `mcad_controller_test.go` and `instascale_controller_test.go` in the `controllers` dir
- Unit test functions are defined in `suite_test.go` (with utils in `util/util.go`) in the `controllers dir`
- Test cases defined under `controllers/testdata`

## Local debugging with VSCode
Steps outlining how to run the operator locally.
- Populate the `.vscode/launch.json` file with the location of your Kubernetes config file and desired namespace.
- In VSCode on the activity bar click `Run and Debug` or `CTRL + SHIFT + D` to start a local debugging session of the CodeFlare Operator.
The operator should be running as intended.

0 comments on commit ea6c4ba

Please sign in to comment.