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: .github/CONTRIBUTING.md
+16-28Lines changed: 16 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,11 +20,11 @@ Before submitting a pull request, please make sure the following is done:
20
20
2. Run `npm install` in the repository root.
21
21
3. If you’ve fixed a bug or added code that should be tested, add tests!
22
22
4. Ensure the test suite passes (`npm test`). Tip: `npm test -- --watch TestName` is helpful in development.
23
-
5.Format your code with prettier (`npm run prettier`).
23
+
5.Lint your code with eslint (`npm run lint`).
24
24
25
25
## Development Setup
26
26
27
-
You need [Node.js](http://nodejs.org) at `v12.0.0+`.
27
+
You need [Node.js](http://nodejs.org) at `Node LTS+`.
28
28
29
29
After cloning the repo, run:
30
30
@@ -38,61 +38,49 @@ $ npm install # or npm
38
38
# dev-server, watch and auto reload playground
39
39
$ npm start
40
40
41
-
# start playground app in production environment
42
-
$ npm run start:prod
43
-
44
-
# runt tslint
41
+
# run tslint
45
42
$ npm run lint
46
43
47
44
# try autofix tslint issues
48
-
$ npm run lint -- --fix
45
+
$ npm run lint:fix
49
46
50
47
# run unit tests
51
48
$ npm run unit
52
49
53
50
# run e2e tests
54
51
$ npm run e2e
55
52
# Make sure you have created bundle before running e2e test
56
-
# E.g. run `npm run bundle` and wait for the finishing process.
53
+
# E.g. run `npm run build` and wait for the finishing process.
57
54
58
-
# open cypress UI to debug e2e test
59
-
$ npm run cy:open
55
+
# open Playwright UI to debug e2e test
56
+
$ npm run e2e:ui
60
57
61
58
# run the unit tests (includes linting and license checks)
62
59
$ npm test
63
60
64
61
# prepare bundles
65
-
$ npm run bundle
66
-
67
-
# format the code using prettier
68
-
$ npm run prettier
62
+
$ npm run build
69
63
70
-
# auto-generate changelog
71
-
$ npm run changelog
72
64
```
73
65
74
66
There are some other scripts available in the `scripts` section of the `package.json` file.
75
67
76
68
## Project Structure
77
69
78
-
-**`benchmark`**: contains basic perf benchmark. Not fully ready yet
70
+
-**`examples`**: contains project demos
79
71
80
-
-**`demo`**: contains project demo with demo specs and HMR playground used in development
81
-
82
-
-`demo/playground`: HMR Playground used in development
72
+
-**`playground`**: HMR Playground used in development
83
73
84
74
-**`docs`**: contains extra docs (linked from README.md)
85
75
86
-
-**`e2e`**: contains e2e tests. The e2e tests are written and run with [Cypress](https://www.cypress.io/).
87
-
76
+
-**`playwright`**: contains e2e tests. The e2e tests are written and run with [Playwright](https://playwright.dev/).
88
77
89
-
-**`src`**: contains the source code. The codebase is written in Typescript. CSS styles are managed with [Styled components](https://www.styled-components.com/). State is managed by [MobX](https://github.com/mobxjs/mobx)
78
+
-**`src`**: contains the source code. The codebase is written in Typescript. CSS styles are managed with [Styled components](https://www.styled-components.com/). State is managed by [Jotai](https://github.com/pmndrs/jotai)
90
79
91
-
-**`src/common-elements`**: contains common Styled elements or components used in multiple places
92
80
-**`src/components`**: contains main visual components
93
-
-**`src/services`**: contains different services used by Redoc including MobX stores
94
-
-**`src/services/models`**: contains classes for OpenAPI entities (e.g. Response, Operations, etc)
81
+
-**`src/services`**: contains different services used by Redoc including Jotai stores
82
+
-**`src/models`**: contains classes for OpenAPI entities (e.g. Response, Operations, etc)
95
83
-**`src/types`**: contains extra typescript typings including OpenAPI doc typings
96
84
-**`src/utils`**: utility functions
97
-
-**`src/styled-components.ts`**: - reexports styled-components with proper typescript annotations using theme
98
-
-**`src/theme.ts`**: - default theme (colors, fonts, etc) used by all the components
85
+
-**`src/jotai`**: - contains Jotai store files
86
+
-**`src/hooks`**: - contains global react hooks for application
0 commit comments