UNPKG

@metaspacecy/information-sdk

Version:

Metaspacecy Information SDK

github.com/MetaSpacecy

MetaSpacecy/Information-SDK

16 lines (15 loc) • 995 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# Contribution Guidelines for Typescript SDK - Coding Styles - File names must use Snake case. For example, `prediction.ts` . - Class names must use Pascal case. For example, `class AuthenticationKey` . - Function and method names must use Camel case. For example, `createEvent` . - Constants must use all caps (upper case) words separated by `_`. For example, `MAX_U32` . - Comments - Comments are required for new classes and functions. - Comments should follow the TSDoc standard, [https://tsdoc.org/](https://tsdoc.org/). - Lints and Formats - ESlint (eslint) and Prettier (prettier) should be used for code checking and code formatting. Make sure to run `pnpm lint` and `pnpm fmt` after making changes to the code. - Tests - Unit tests are required for any non-trivial changes you make. - The Jest testing framework is used in the repo and we recommend you use it. See Jest: [https://jestjs.io/](https://jestjs.io/). - Make sure to run `pnpm test` after making changes.