Skip to content

Commit

Permalink
docs: update contrib guide
Browse files Browse the repository at this point in the history
  • Loading branch information
nerdyman committed May 10, 2022
1 parent 0493b6d commit 3976d94
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,21 @@ npm run dx
Then run the following commands in separate terminals:

```sh
# Start the library dev build
# Run both the library dev build and the `example` repo dev server
pnpm run dev

# Or run them separately
## Start the library dev build
pnpm run start
# Start the Example codebase dev build
## Start the `example` codebase dev build
pnpm run --prefix example start
```

## Standards

- Commits use the [Conventional Commits](https://conventionalcommits.org/) standard
- pnpm is used to manage dependencies
- nvm is used to manage Node.js versions
- pnpm to manage dependencies
- nvm to manage Node.js versions
- Prettier & EditorConfig for code style
- ESLint for quality
- Husky for Git hooks
Expand Down

0 comments on commit 3976d94

Please sign in to comment.