Skip to content
This repository has been archived by the owner on Mar 28, 2022. It is now read-only.

Latest commit

 

History

History
25 lines (16 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

25 lines (16 loc) · 1.02 KB

How to contribute

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 structure

Source code is structured into several folders:

  • lib which contains the SDK source code;
  • tests which contains unit tests written using jest.

Testing

Unit tests should be added or updated each time a PR is submitted.

Documentation

Packages and public methods should be properly commented with relevant information.