Skip to content

Commit ebda0e7

Browse files
update: Contributing guide for current steps
1 parent 7c9c934 commit ebda0e7

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

.github/CONTRIBUTING.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
1+
# How to Contribute
2+
13
## Issues/Feedback/Requests
4+
25
- Create a new issue [here](https://github.com/obs-websocket-community-projects/obs-websocket-js/issues/new), please be as descriptive as possible.
36

47
## Building the Project Locally
5-
- Install [node.js](http://nodejs.org)
8+
9+
- Install [node.js v18.18 or greater](http://nodejs.org)
610
- Clone/Fork the repo
711
- Install dependencies with `npm install`
812
- Generate the browser distributable Javascript file with `npm run build`
913
- Or `npm run watch` to automatically build when files are modified.
10-
- This project makes use of eslint, run `npm run test:static` for linting and `npm run test:ava` for basic unit testing. If you have the types compiled you can also run `npm run test:types`.
14+
- This project makes use of eslint, run `npm run lint` for linting and `npm run test` for basic unit testing.
1115

1216
## Building Typings Locally
17+
1318
- Export GH_TOKEN as an environment variable, using a generated Personal Access Token.
1419
- `npm run build:types`
1520

1621
## Contributing Guidelines
22+
1723
- Please use descriptive commit messages.
1824
- When submitting a Pull Request, reference related [Issues](https://github.com/obs-websocket-community-projects/obs-websocket-js/issues) if any exist.

0 commit comments

Comments
 (0)