1- # Contributing to Dash
1+ # Contributing to @ dash-ui/unitless
22
33To contribute to this project, first:
44
551 . [ Fork this repo to your account] ( https://docs.github.com/en/github/getting-started-with-github/fork-a-repo )
6- 2 . ``` sh
7- # Create a directory for Dash if you don't already have one
8- mkdir dash-ui
9- cd dash-ui
10- # Clone your forked repo
11- git clone https://github.com/[your-username]/unitless.git
12- # Install the repo using Yarn
13- cd unitless
14- yarn install
6+ 2 . [ Clone this repo] ( https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository ) to your local machine
7+ 3 . ``` sh
8+ # Install the repo using pnpm
9+ cd [repo-name]
10+ pnpm install
1511 # Start dev mode
16- yarn dev
12+ pnpm dev
1713 ```
1814
1915## Before you contribute
@@ -29,7 +25,7 @@ Before your PR will be considered I will look for:
2925
3026- ** Documentation** Please submit updates to the docs when public-facing APIs are changed.
3127- ** Tests** Your PR will not be accepted if it doesn't have well-designed tests. Additionally, make sure
32- that you run ` yarn validate` before you submit your PR and make sure your PR passes the linting rules,
28+ that you run ` pnpm validate` before you submit your PR and make sure your PR passes the linting rules,
3329 type checking, and tests that already exist.
3430- ** Types** Your types should be as strong as possible.
3531- ** Comments** If your PR implements non-obvious logic, I fully expect you to explain the rationale in
@@ -38,7 +34,7 @@ Before your PR will be considered I will look for:
3834
3935## Development
4036
41- Here's what you need to know to start developing Dash .
37+ Here's what you need to know to start developing ` @dash-ui/unitless ` .
4238
4339### Package scripts
4440
@@ -62,30 +58,21 @@ Formats all of the applicable source files with prettier
6258
6359Runs ` eslint ` on the package source
6460
65- #### ` prerelease `
66-
67- Runs before the package is published. This calls ` validate ` and ` build ` scripts.
68-
69- #### ` release `
70-
71- Starts a release using ` standard-version ` . This must be run before ` npm publish ` .
72-
7361#### ` test `
7462
7563Tests the package with ` jest `
7664
7765#### ` validate `
7866
79- Runs ` check-types ` , ` lint ` , and ` test ` scripts. This is used in CI and
80- in ` prerelease ` .
67+ Runs ` check-types ` , ` lint ` , and ` test ` scripts.
8168
8269---
8370
8471### Husky hooks
8572
8673#### ` pre-commit `
8774
88- Runs ` lint-staged ` and the ` build-types ` script
75+ Runs ` lint-staged ` script
8976
9077#### ` commit-msg `
9178
0 commit comments