Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

65 lines (41 loc) · 1.93 KB
Raw

Contributing

Contributions are welcome!

Code of Conduct

Before contributing to this repository for the first time, please review our project's Code of Conduct.

Getting Started

Issues

  • Open or search for issues with the label area/api.

  • If a related issue doesn't exist, you can open a new issue using a relevant issue form. You can tag issues with /area api.

Building

To build the CRD and the various schemas, you don't need to install any pre-requisite apart from docker or podman. In the root directory, if you are using podman first run export USE_PODMAN=true. Then for either docker or podman run the following command:

bash ./docker-run.sh ./build.sh

Typescript model

Typescript model is generated based on JSON Schema with help of https://github.com/kubernetes-client/gen. To generate them locally run:

bash ./build/typescript-model/generate.sh

Testing

Find more information about tests in the testing document.

# schemaTest approach
cd test/v200/schemaTest
go test -v
# apiTest approach
cd test/v200/apiTest
go test -v

Pull Requests

All commits must be signed off with the footer:

Signed-off-by: Firstname Lastname <email@email.com>

Once you set your user.name and user.email in your git config, you can sign your commit automatically with git commit -s. When you think the code is ready for review, create a pull request and link the issue associated with it.

Owners of the repository will watch out for and review new PRs.

If comments have been given in a review, they have to be addressed before merging.

After addressing review comments, don’t forget to add a comment in the PR afterward, so everyone gets notified by Github and knows to re-review.