Skip to content

Commit 279ac09

Browse files
Maxusmustiopenshift-merge-robot
authored andcommitted
Review feedback applied
1 parent fb0727e commit 279ac09

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,24 @@ Here are a few things to go over before getting started with CodeFlare Operator
55
## Environment setup
66

77
The following should be installed in your working environment:
8-
installation/)
98
- Go 1.18.X
109
- [Download release](https://go.dev/dl/)
1110
- [Install Instructions](https://go.dev/doc/install)
1211
- [Operator SDK](https://sdk.operatorframework.io/docs/installation/)
1312
- GCC
1413

1514
## Basic Overview
16-
Under the `api` dir, the MCAD and InstaScale custom resources are defined:
15+
The main entrypoint for the operator is `main.go`
16+
17+
The MCAD and InstaScale custom resources are defined under the `api` dir:
1718
- See `mcad_types.go` and `instascale_types.go`
1819

19-
Under `config/internal` are where the MCAD and InstaScale resource templates can be found:
20+
The MCAD and InstaScale resource templates can be found under `config/internal`:
2021
- Sorted under `mcad` and `insascale` subdirs
2122

22-
The code for MCAD/InstaScale resource reconsilliation can be found in the `controllers` dir:
23+
The code for MCAD/InstaScale resource reconcilliation can be found in the `controllers` dir:
2324
- See `mcad_controller.go` and `instascale_controller.go`
2425

25-
The main entrypoint for the operator is `main.go`
26-
2726
## Building and Deployment
2827
If changes are made in the `api` dir, run: `make manifests`
2928
- This will generate new CRDs and associated files
@@ -44,6 +43,7 @@ For deploying onto a cluster:
4443
The CodeFlare Operator currently has unit tests and pre-commit checks
4544
- To enable and view pre-commit checks: `pre-commit install`
4645
- To run unit tests, run `make test-unit`
46+
- Note that both are required for CI to pass on pull requests
4747

4848
To write and inspect unit tests:
4949
- MCAD and InstaScale unit tests under `mcad_controller_test.go` and `instascale_controller_test.go` in the `controllers` dir

0 commit comments

Comments
 (0)