CONTRIBUTION.md

Develop iWF Golang SDK

Repo layout

Any contribution is welcome. Even just a fix for typo in a code comment, or README/wiki.

Here is the repository layout if you are interested to learn about it:

• gen/ the generated code from iwf-idl (Open API definition/Swagger)
• integ/ the end to end integration tests.
  • init.go the initiation & registration of workflows. It's using global variables just for convenience
  • main_test the setup + tear down for running local in-memory iWF worker with GoSDK
  • xyz_test the test for a test case xyz
  • xyz_workflow.go the test workflow for a test xyz
  • xyz_workflow_state_* the test workflow states for a test xyz
• iwf-idl/ the idl submodule
• iwf the main directory
  • *_impl.go these are implementation for SDK. Ideally we should put them in separate folder, but Golang doesn't allow circular dependency, and we hate to use alias across packages
  • internal_*.go these are implementation for SDK
  • _test.go the unit test
  • other .go the interfaces defined in this SDK for user to use

How to update IDL and the generated code

1. Install openapi-generator using Homebrew if you haven't. See more documentation
2. Check out the idl submodule by running the command: git submodule update --init --recursive
3. Run the command git submodule update --remote --merge to update IDL to the latest commit
4. Run make idl-code-gen to refresh the generated code

Coding convention

There are lots of convention that we love here that we haven't summarized all of them. So you may get some code review feedback about more than just below:

• The private struct shouldn't let other structs to access their private fields. Since all the impls are in the same package, it's possible to write the code with the random access, but it would be a nightmare to maintain. We recommend to always expose a method (like getter) for external code to use