Skip to content

Commit 96090e6

Browse files
committed
update contrib guide
Signed-off-by: Sebastian Hoß <[email protected]>
1 parent da18949 commit 96090e6

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ $ ./code-generator/fix-cargo-warnings.sh <feature_name>
5454

5555
### 4. Adjust Output
5656

57+
In some cases, kopium is not able to generate all required code to compile a custom resource. In those cases, add a `.rs` file next to the downloaded `.yaml` file in the catalog and write the missing code into that file. The code inside that file will be appended at the end of the generated code. The file name must match the name of the CRD, e.g. `prometheus-operator-prometheus.yaml` would require a file called `prometheus-operator-prometheus.rs`.
58+
5759
Some CRDs cannot be converted to Rust code at all. In those cases, add an `.ignore` file next to the downloaded `.yaml` file in the catalog and write the reason why this CRD was ignored into the file, e.g.:
5860

5961
```

0 commit comments

Comments
 (0)