Developer tools
Style checkers
Recommended style checkers are
- Go: golint
- Java: checkstyle
- Node: eslint
- Python: pylint
Code coverage
Recommended test coverage tools are:
Package management / distribution
It is highly recommended that individual services belonging to an IBM Cloud service category are delivered together within a single SDK project (one project per language). For example, the services within the Platform Services category are contained
within the platform-services-go-sdk project.
Recommended package management / distribution systems:
Go
Your Go SDK should be packaged as a Go Module, using the GitHub repository URL as a package name.
Java
Your Java SDK should publish its artifacts on Maven Central. It is recommended that artifacts use a Maven groupId of com.ibm.cloud.
Node
Your Node SDK should be released as an npm package within the @ibm-cloud organization. It is recommended that your package name follows the
pattern of ibm-<service-category> if possible (for example, ibm-platform-services or ibm-networking-services). Using NPM Scopes is strongly encouraged.
Python
Your Python SDK should be released on PyPI / pip and should have a package name beginning with ibm-. It is recommended that your package name
follows the pattern of ibm-<service-category> if possible (for example, ibm-platform-services or ibm-networking-services).
Additional information is present in the Common SDK Documentation.