mirror of
https://github.com/hanzoai/uuid.git
synced 2026-09-24 17:04:02 +00:00
29 lines
582 B
Markdown
29 lines
582 B
Markdown
# Contributing
|
|
|
|
## Development
|
|
|
|
1. Clone this repo
|
|
2. `npm install` to install dev dependencies
|
|
3. VSCode is the recommended dev environment
|
|
|
|
- Includes "Build Watcher" and "Test Watcher" tasks (Terminal pane)
|
|
- (optional) Install the recommended extensions (Extensions sidebar)
|
|
|
|
4. Before submitting your PR, make sure tests pass:
|
|
|
|
- `npm test && npm run test:node`
|
|
|
|
## README updates
|
|
|
|
**Do not edit README.md manually**. To make changes to the README:
|
|
|
|
1. Edit README_js.md
|
|
2. Run `npm run docs` to regenerate README.md
|
|
3. If using VSCode, it's
|
|
|
|
## Testing
|
|
|
|
```shell
|
|
npm test
|
|
```
|