Thanks for caring enough about this project to check out these guidelines - new contributors are always welcome!
Please let us know by opening an issue.
- node v16
- yarn
git clone https://github.com/nsfm/dualsense-ts
cd dualsense-ts
yarn install
# Compiles the project to `dist/`
yarn build
# Check lint and style adherence
yarn lint
# Run unit tests
yarn test
# Run unit tests with code coverage
yarn coverage
# Run the node example app, with live compilation and source mapping for the Inspector
yarn debug
# Run the webhid example app at localhost:3000
# This will update automatically as you save changes to the app, but if you
# modify the core library you must stop the server and run `yarn build`
yarn --cwd webhid_example start
The project and tools have been tested on these operating systems:
- Arch Linux x64 (kernel 5.16.15 onwards)
- Ubuntu 20.04.4 x64
If your system isn't covered here and everything works, please open a PR and let us know!
Changes facilitating compatibility with new platforms are always welcome.
This project prefers to maintain a minimal dependency footprint within the final build.
dependencies
will face scrutiny; they should demonstrate significant value and come from a stable source.optionalDependencies
are preferred overdependencies
.devDependencies
should simplify or improve the dev experience.
- CI checks must pass
- Test coverage maintained where appropriate
- Change should improve the repo 👍