You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+19-11Lines changed: 19 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,30 +13,38 @@ Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in
13
13
3. If you’ve fixed a bug or added code that should be tested.
14
14
4. Ensure the test suite passes by running `yarn test`.
15
15
5. Update the [README.md](README.md) with details of changes to the interface.
16
-
6. Update the [demo app](demo) if needed.
16
+
6. Update the [demo app](app/src) if needed.
17
17
7. Make sure your code lints by running `yarn lint`.
18
18
19
19
## Development Workflow
20
20
21
-
After cloning USE-WEB-ANIMATIONS, run `yarn` to fetch its dependencies. Then, you can run several commands:
21
+
You can test new features or debug an issue by the way that I'm using.
22
22
23
-
-`yarn dev` runs the [demo app](demo) as your playground at `localhost:10001`. Support live reloading.
23
+
1. Run `yarn link-pkg` to link the package into the [app directory](app).
24
+
2. Run `yarn start` to create an `ESM` build and type definition file by `rollup` watch mode.
25
+
3. Access the [app directory](app).
26
+
4. In the **app directory**, run `yarn link-pkg` to link with the package then run `yarn start` to start development.
27
+
5. Try something cool via the [demo app](app/src).
28
+
29
+
## Development Workflow
30
+
31
+
There're several useful commands that you can use during the development:
32
+
33
+
-`yarn link-pkg` links the package into the [app directory](app). You can develop or debug it via the [demo app](app/src).
34
+
-`yarn start` creates a `dist` folder with an `ESM` build and type definition file by `rollup` watch mode.
24
35
-`yarn lint:code` lints all `.js` and `.tsx?` files.
25
36
-`yarn lint:type` runs the [TypeScript](https://www.typescriptlang.org) type-checks.
26
-
-`yarn lint:style` lints all `.css` and `.tsx?` (for [Emotion](https://emotion.sh)) files.
27
37
-`yarn lint:format` formats all files except the file list of `.prettierignore`.
28
-
-`yarn lint` lints `code`, `type`, `style`, and `format`.
38
+
-`yarn lint` lints `code`, `type`, and `format`.
29
39
-`yarn test` runs the complete test suite.
30
40
-`yarn test:watch` runs an interactive test watcher (helpful in development).
31
41
-`yarn test:cov` runs the complete test suite with coverage report.
32
-
-`yarn build:demo` creates a `public` folder with all the static files.
33
-
-`yarn build:dist` creates a `dist` folder with package builds (`CJS` & `ESM`) and type definition file. You can test the package locally via [yarn link](https://yarnpkg.com/lang/en/docs/cli/link).
34
-
-`yarn build` creates both `public` and `dist`.
35
-
-`yarn clean:dev` deletes the `demo/.dev` build folder.
36
-
-`yarn clean:demo` deletes the `public` build folder.
42
+
-`yarn build:dev` creates a `dist` folder with an `ESM` build and type definition file for development.
43
+
-`yarn build:prod` creates a `dist` folder with package builds (`CJS` & `ESM`) and type definition file. You can test the package locally via [yarn link](https://yarnpkg.com/lang/en/docs/cli/link).
37
44
-`yarn clean:dist` deletes the `dist` build folder.
45
+
-`yarn clean:size` deletes the `.size-snapshot.json` file.
38
46
-`yarn clean:cov` deletes the `coverage` report folder.
39
-
-`yarn clean` deletes all the build/coverage folders.
47
+
-`yarn clean` deletes build, test, and size relevant files.
0 commit comments