A TypeScript/JavaScript client library for PowerTrade's API
Check out TODO.md for project progress
Install dependencies
$ yarn
$ yarn test
$ yarn lint
Code formatting is done through prettier.
It is recommended to use it through plugins, but there is a command available:
$ yarn format
Commit messages should follow the Conventional Commits specification.
Commit messages should be chosen carefully as they will be used to generate release notes.
- For new features, use
feat:for examplefeat: Add new awesome feature - For bug fixes, use
fix:for examplefix: Fix login error - For commits that should not be included in the release notes, use
chore:for examplechore: fix unit tests
The 3 commits above would result in the following release notes:
### Features
* Add new awesome feature
### Bug Fixes
* Fix login error
Note: commit messages are linted with @commitlint/config-conventional
To update CHANGELOG.md, tag the release and bump the version in package.json:
$ yarn release
By default this will bump the 'minor' number of the version: 1.2.3 -> 1.3.0
To bump the 'patch' number, use yarn release:patch: 1.2.3 -> 1.2.4
To set an arbitrary new version, use yarn release -- --release-as 2.2.2