If you found a bug or issue, please ensure the bug was not already reported by searching in GitHub issues. If you are unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, the SDK version, and a code sample demonstrating the issue.
If you open a PR to fix any issue, please reference the ticket in the PR title. A Symphony SDK team member will have to approve before it is merged and eventually released.
Source code is divided into three main packages:
- sym_api_client_python which contains the SDK source code;
- tests which contains unit tests;
- examples which contains code samples illustrating SDK basic usage.
Unit tests should be added or updated each time a PR is submitted.
The guidelines outlined in PEP 8 should be followed on any code update.
Public classes and methods should be properly documented using javadoc. Main features should be documented using Markdown under the docs folder and exemplified with runnable code under the examples package.