Update the readme and contributing doc before publishing to github repo. https://github.com/vmware/vmware-go-kcl Jira CNA-2036 Change-Id: Idd8cfd8c89d3202613ff1d3018a584945ad30e4a |
||
|---|---|---|
| clientlibrary | ||
| support | ||
| vendor | ||
| .gitignore | ||
| .gitreview | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| HyperMake | ||
| LICENSE | ||
| README.md | ||
vmware-go-kcl-v2
Overview
Try it out
Prerequisites
- Prereq 1
- Prereq 2
- Prereq 3
Build & Run
- Step 1
- Step 2
- Step 3
Documentation
Contributing
The vmware-go-kcl-v2 project team welcomes contributions from the community. Before you start working with vmware-go-kcl-v2, please read our Developer Certificate of Origin. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. For more detailed information, refer to CONTRIBUTING.md.
License
Build & Run
hmake
# security scan
hmake scanast
# run test
hmake check
# run integration test
# update the worker_test.go to let it point to your Kinesis stream
hmake test
Documentation
VMware-Go-KCL matches exactly the same interface and programming model from original Amazon KCL, the best place for getting reference, tutorial is from Amazon itself:
Releases & Major Branches
Contributing
The vmware-go-kcl project team welcomes contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any questions about the CLA process, please refer to our FAQ. For more detailed information, refer to CONTRIBUTING.md.
License
MIT License