Skip to content

Commit

Permalink
Add Technical and style guide to the contribution gude
Browse files Browse the repository at this point in the history
Signed-off-by: tenzen-y <yuki.iwai.tz@gmail.com>
  • Loading branch information
tenzen-y committed Jan 3, 2024
1 parent 4617346 commit 044d82e
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,20 @@ You can undeploy Katib v1beta1 manifests from a Kubernetes cluster as follows:
make undeploy
```

## Technical and style guide

The following guidelines apply primarily to Katib,
but other projects like training-operator might also adhere to them.

When coding:

- Follow [effective go](https://go.dev/doc/effective_go) guidelines.

Testing:

- Use `cmp.Diff` instead of `reflect.Equal`, to provide useful comparisons.
- Define test cases as maps instead of slices to avoid dependencies on te running order.

## Modify controller APIs

If you want to modify Katib controller APIs, you have to
Expand Down

0 comments on commit 044d82e

Please sign in to comment.